libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudWatch.TagResource

Description

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.

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 an alarm 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 resource.

Synopsis

Creating a Request

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource' 

Fields

  • resourceARN :: Text

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

    The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name

    The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name

    For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

  • tags :: [Tag]

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

Instances

Instances details
Eq TagResource Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

Read TagResource Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

Show TagResource Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

Generic TagResource Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

Associated Types

type Rep TagResource :: Type -> Type #

NFData TagResource Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

Methods

rnf :: TagResource -> () #

Hashable TagResource Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

AWSRequest TagResource Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

Associated Types

type AWSResponse TagResource #

ToHeaders TagResource Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

Methods

toHeaders :: TagResource -> [Header] #

ToPath TagResource Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

ToQuery TagResource Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

type Rep TagResource Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.CloudWatch.TagResource" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag])))
type AWSResponse TagResource Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

newTagResource Source #

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 CloudWatch resource that you're adding tags to.

The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name

The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name

For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

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

Request Lenses

tagResource_resourceARN :: Lens' TagResource Text Source #

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

The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name

The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name

For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

tagResource_tags :: Lens' TagResource [Tag] Source #

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

Destructuring the Response

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse' 

Fields

Instances

Instances details
Eq TagResourceResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

Read TagResourceResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

Show TagResourceResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

Generic TagResourceResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

Associated Types

type Rep TagResourceResponse :: Type -> Type #

NFData TagResourceResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

Methods

rnf :: TagResourceResponse -> () #

type Rep TagResourceResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.TagResource

type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.CloudWatch.TagResource" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTagResourceResponse Source #

Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.

Response Lenses