Copyright | (c) 2013-2021 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 |
Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.
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 an IAM customer managed policy 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.
- 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
- data TagPolicy = TagPolicy' {}
- newTagPolicy :: Text -> TagPolicy
- tagPolicy_policyArn :: Lens' TagPolicy Text
- tagPolicy_tags :: Lens' TagPolicy [Tag]
- data TagPolicyResponse = TagPolicyResponse' {
- newTagPolicyResponse :: TagPolicyResponse
Creating a Request
See: newTagPolicy
smart constructor.
TagPolicy' | |
|
Instances
Create a value of TagPolicy
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:policyArn:TagPolicy'
, tagPolicy_policyArn
- The ARN of the IAM customer managed policy 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:TagPolicy'
, tagPolicy_tags
- The list of tags that you want to attach to the IAM customer managed
policy. Each tag consists of a key name and an associated value.
Request Lenses
tagPolicy_policyArn :: Lens' TagPolicy Text Source #
The ARN of the IAM customer managed policy 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: _+=,.@-
tagPolicy_tags :: Lens' TagPolicy [Tag] Source #
The list of tags that you want to attach to the IAM customer managed policy. Each tag consists of a key name and an associated value.
Destructuring the Response
data TagPolicyResponse Source #
See: newTagPolicyResponse
smart constructor.
Instances
Eq TagPolicyResponse Source # | |
Defined in Amazonka.IAM.TagPolicy (==) :: TagPolicyResponse -> TagPolicyResponse -> Bool # (/=) :: TagPolicyResponse -> TagPolicyResponse -> Bool # | |
Read TagPolicyResponse Source # | |
Defined in Amazonka.IAM.TagPolicy | |
Show TagPolicyResponse Source # | |
Defined in Amazonka.IAM.TagPolicy showsPrec :: Int -> TagPolicyResponse -> ShowS # show :: TagPolicyResponse -> String # showList :: [TagPolicyResponse] -> ShowS # | |
Generic TagPolicyResponse Source # | |
Defined in Amazonka.IAM.TagPolicy type Rep TagPolicyResponse :: Type -> Type # from :: TagPolicyResponse -> Rep TagPolicyResponse x # to :: Rep TagPolicyResponse x -> TagPolicyResponse # | |
NFData TagPolicyResponse Source # | |
Defined in Amazonka.IAM.TagPolicy rnf :: TagPolicyResponse -> () # | |
type Rep TagPolicyResponse Source # | |
newTagPolicyResponse :: TagPolicyResponse Source #
Create a value of TagPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.