| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.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 it is reserved for AWS 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 your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
Important: 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.
Creating a Request
Arguments
| :: Text | |
| -> TagResource |
Creates a value of TagResource with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
trSecretId- 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.trTags- The tags to attach to the secret. Each element in the list consists of aKeyand aValue. This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide . For the AWS CLI, you can also use the syntax:--Tags Key=Key1,Value=Value1,Key=Key2,Value=Value2[,…]
data TagResource Source #
See: tagResource smart constructor.
Instances
Request Lenses
trSecretId :: 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.
trTags :: 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 information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide . For the AWS CLI, you can also use the syntax: --Tags Key=Key1,Value=Value1,Key=Key2,Value=Value2[,…]
Destructuring the Response
tagResourceResponse :: TagResourceResponse Source #
Creates a value of TagResourceResponse with the minimum fields required to make a request.
data TagResourceResponse Source #
See: tagResourceResponse smart constructor.