libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager
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.SecretsManager.TagResource

Description

Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

The following basic restrictions apply to tags:

  • Maximum number of tags per secret—50
  • Maximum key length—127 Unicode characters in UTF-8
  • Maximum value length—255 Unicode characters in UTF-8
  • Tag keys and values are case sensitive.
  • Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
  • If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:TagResource

Related operations

  • To remove one or more tags from the collection attached to a secret, use UntagResource.
  • To view the list of tags attached to a secret, use DescribeSecret.
Synopsis

Creating a Request

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource' 

Fields

  • secretId :: Text

    The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

  • tags :: [Tag]

    The tags to attach to the secret. Each element in the list consists of a Key and a Value.

    This parameter to the API requires a JSON text string argument.

    For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

Instances

Instances details
Eq TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Read TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Show TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Generic TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Associated Types

type Rep TagResource :: Type -> Type #

NFData TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Methods

rnf :: TagResource -> () #

Hashable TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

ToJSON TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

AWSRequest TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Associated Types

type AWSResponse TagResource #

ToHeaders TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Methods

toHeaders :: TagResource -> [Header] #

ToPath TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

ToQuery TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

type Rep TagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

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

Defined in Amazonka.SecretsManager.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:secretId:TagResource', tagResource_secretId - The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

$sel:tags:TagResource', tagResource_tags - The tags to attach to the secret. Each element in the list consists of a Key and a Value.

This parameter to the API requires a JSON text string argument.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

Request Lenses

tagResource_secretId :: Lens' TagResource Text Source #

The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

tagResource_tags :: Lens' TagResource [Tag] Source #

The tags to attach to the secret. Each element in the list consists of a Key and a Value.

This parameter to the API requires a JSON text string argument.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

Destructuring the Response

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse' 

Instances

Instances details
Eq TagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Read TagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Show TagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Generic TagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Associated Types

type Rep TagResourceResponse :: Type -> Type #

NFData TagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

Methods

rnf :: TagResourceResponse -> () #

type Rep TagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.TagResource

type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.SecretsManager.TagResource" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" '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.