Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudWatchLogs.TagResource

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a CloudWatch Logs resource.

Synopsis

data TagResource = TagResource' {
- resourceArn :: Text
- tags :: HashMap Text Text
}
newTagResource :: Text -> TagResource
tagResource_resourceArn :: Lens' TagResource Text
tagResource_tags :: Lens' TagResource (HashMap Text Text)
data TagResourceResponse = TagResourceResponse' {
}
newTagResourceResponse :: TagResourceResponse

Creating a Request

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource'

Fields

resourceArn :: Text
The ARN of the resource that you're adding tags to.
The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name
The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name
For more information about ARN format, see CloudWatch Logs resources and operations.
tags :: HashMap Text Text
The list of key-value pairs to associate with the resource.

Instances

Instances details

ToJSON TagResource Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Methods toJSON :: TagResource -> Value # toEncoding :: TagResource -> Encoding # toJSONList :: [TagResource] -> Value # toEncodingList :: [TagResource] -> Encoding #
ToHeaders TagResource Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Methods toHeaders :: TagResource -> [Header] #
ToPath TagResource Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Methods toPath :: TagResource -> ByteString #
ToQuery TagResource Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Methods toQuery :: TagResource -> QueryString #
AWSRequest TagResource Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Associated Types type AWSResponse TagResource # Methods request :: (Service -> Service) -> TagResource -> Request TagResource # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TagResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TagResource))) #
Generic TagResource Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Associated Types type Rep TagResource :: Type -> Type # Methods from :: TagResource -> Rep TagResource x # to :: Rep TagResource x -> TagResource #
Read TagResource Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Methods readsPrec :: Int -> ReadS TagResource # readList :: ReadS [TagResource] # readPrec :: ReadPrec TagResource # readListPrec :: ReadPrec [TagResource] #
Show TagResource Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Methods showsPrec :: Int -> TagResource -> ShowS # show :: TagResource -> String # showList :: [TagResource] -> ShowS #
NFData TagResource Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Methods rnf :: TagResource -> () #
Eq TagResource Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Methods (==) :: TagResource -> TagResource -> Bool # (/=) :: TagResource -> TagResource -> Bool #
Hashable TagResource Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Methods hashWithSalt :: Int -> TagResource -> Int # hash :: TagResource -> Int #
type AWSResponse TagResource Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource type AWSResponse TagResource = TagResourceResponse
type Rep TagResource Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.CloudWatchLogs.TagResource" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))

newTagResource Source #

Arguments

:: Text	`$sel:resourceArn:TagResource'`
-> TagResource

Create a value of TagResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceArn:TagResource', tagResource_resourceArn - The ARN of the resource that you're adding tags to.

The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name

The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name

For more information about ARN format, see CloudWatch Logs resources and operations.

$sel:tags:TagResource', tagResource_tags - The list of key-value pairs to associate with the resource.

Request Lenses

tagResource_resourceArn :: Lens' TagResource Text Source #

The ARN of the resource that you're adding tags to.

The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name

The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name

For more information about ARN format, see CloudWatch Logs resources and operations.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The list of key-value pairs to associate with the resource.

Destructuring the Response

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse'

Instances

Instances details

Generic TagResourceResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Associated Types type Rep TagResourceResponse :: Type -> Type # Methods from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse #
Read TagResourceResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Methods readsPrec :: Int -> ReadS TagResourceResponse # readList :: ReadS [TagResourceResponse] # readPrec :: ReadPrec TagResourceResponse # readListPrec :: ReadPrec [TagResourceResponse] #
Show TagResourceResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Methods showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS #
NFData TagResourceResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Methods rnf :: TagResourceResponse -> () #
Eq TagResourceResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource Methods (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool #
type Rep TagResourceResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.TagResource type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.CloudWatchLogs.TagResource" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newTagResourceResponse :: TagResourceResponse Source #

Create a value of TagResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.