libZSservicesZSamazonka-certificatemanagerZSamazonka-certificatemanager
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.CertificateManager.AddTagsToCertificate

Description

Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.

You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.

To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.

Synopsis

Creating a Request

data AddTagsToCertificate Source #

See: newAddTagsToCertificate smart constructor.

Constructors

AddTagsToCertificate' 

Fields

  • certificateArn :: Text

    String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

  • tags :: NonEmpty Tag

    The key-value pair that defines the tag. The tag value is optional.

Instances

Instances details
Eq AddTagsToCertificate Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

Read AddTagsToCertificate Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

Show AddTagsToCertificate Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

Generic AddTagsToCertificate Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

Associated Types

type Rep AddTagsToCertificate :: Type -> Type #

NFData AddTagsToCertificate Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

Methods

rnf :: AddTagsToCertificate -> () #

Hashable AddTagsToCertificate Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

ToJSON AddTagsToCertificate Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

AWSRequest AddTagsToCertificate Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

Associated Types

type AWSResponse AddTagsToCertificate #

ToHeaders AddTagsToCertificate Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

ToPath AddTagsToCertificate Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

ToQuery AddTagsToCertificate Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

type Rep AddTagsToCertificate Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

type Rep AddTagsToCertificate = D1 ('MetaData "AddTagsToCertificate" "Amazonka.CertificateManager.AddTagsToCertificate" "libZSservicesZSamazonka-certificatemanagerZSamazonka-certificatemanager" 'False) (C1 ('MetaCons "AddTagsToCertificate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Tag))))
type AWSResponse AddTagsToCertificate Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

newAddTagsToCertificate Source #

Create a value of AddTagsToCertificate 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:certificateArn:AddTagsToCertificate', addTagsToCertificate_certificateArn - String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs).

$sel:tags:AddTagsToCertificate', addTagsToCertificate_tags - The key-value pair that defines the tag. The tag value is optional.

Request Lenses

addTagsToCertificate_certificateArn :: Lens' AddTagsToCertificate Text Source #

String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs).

addTagsToCertificate_tags :: Lens' AddTagsToCertificate (NonEmpty Tag) Source #

The key-value pair that defines the tag. The tag value is optional.

Destructuring the Response

data AddTagsToCertificateResponse Source #

See: newAddTagsToCertificateResponse smart constructor.

Instances

Instances details
Eq AddTagsToCertificateResponse Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

Read AddTagsToCertificateResponse Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

Show AddTagsToCertificateResponse Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

Generic AddTagsToCertificateResponse Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

Associated Types

type Rep AddTagsToCertificateResponse :: Type -> Type #

NFData AddTagsToCertificateResponse Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

type Rep AddTagsToCertificateResponse Source # 
Instance details

Defined in Amazonka.CertificateManager.AddTagsToCertificate

type Rep AddTagsToCertificateResponse = D1 ('MetaData "AddTagsToCertificateResponse" "Amazonka.CertificateManager.AddTagsToCertificate" "libZSservicesZSamazonka-certificatemanagerZSamazonka-certificatemanager" 'False) (C1 ('MetaCons "AddTagsToCertificateResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newAddTagsToCertificateResponse :: AddTagsToCertificateResponse Source #

Create a value of AddTagsToCertificateResponse with all optional fields omitted.

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