libZSservicesZSamazonka-iamZSamazonka-iam
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.IAM.TagServerCertificate

Description

Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.

For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a server certificate that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
  • Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
Synopsis

Creating a Request

data TagServerCertificate Source #

See: newTagServerCertificate smart constructor.

Constructors

TagServerCertificate' 

Fields

  • serverCertificateName :: Text

    The name of the IAM server certificate to which you want to add tags.

    This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

  • tags :: [Tag]

    The list of tags that you want to attach to the IAM server certificate. Each tag consists of a key name and an associated value.

Instances

Instances details
Eq TagServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

Read TagServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

Show TagServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

Generic TagServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

Associated Types

type Rep TagServerCertificate :: Type -> Type #

NFData TagServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

Methods

rnf :: TagServerCertificate -> () #

Hashable TagServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

AWSRequest TagServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

Associated Types

type AWSResponse TagServerCertificate #

ToHeaders TagServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

ToPath TagServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

ToQuery TagServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

type Rep TagServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

type Rep TagServerCertificate = D1 ('MetaData "TagServerCertificate" "Amazonka.IAM.TagServerCertificate" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "TagServerCertificate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverCertificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag])))
type AWSResponse TagServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

newTagServerCertificate Source #

Create a value of TagServerCertificate 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:serverCertificateName:TagServerCertificate', tagServerCertificate_serverCertificateName - The name of the IAM server certificate to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

$sel:tags:TagServerCertificate', tagServerCertificate_tags - The list of tags that you want to attach to the IAM server certificate. Each tag consists of a key name and an associated value.

Request Lenses

tagServerCertificate_serverCertificateName :: Lens' TagServerCertificate Text Source #

The name of the IAM server certificate to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

tagServerCertificate_tags :: Lens' TagServerCertificate [Tag] Source #

The list of tags that you want to attach to the IAM server certificate. Each tag consists of a key name and an associated value.

Destructuring the Response

data TagServerCertificateResponse Source #

See: newTagServerCertificateResponse smart constructor.

Instances

Instances details
Eq TagServerCertificateResponse Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

Read TagServerCertificateResponse Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

Show TagServerCertificateResponse Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

Generic TagServerCertificateResponse Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

Associated Types

type Rep TagServerCertificateResponse :: Type -> Type #

NFData TagServerCertificateResponse Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

type Rep TagServerCertificateResponse Source # 
Instance details

Defined in Amazonka.IAM.TagServerCertificate

type Rep TagServerCertificateResponse = D1 ('MetaData "TagServerCertificateResponse" "Amazonka.IAM.TagServerCertificate" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "TagServerCertificateResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newTagServerCertificateResponse :: TagServerCertificateResponse Source #

Create a value of TagServerCertificateResponse with all optional fields omitted.

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