Copyright | (c) 2013-2017 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 |
Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide .
- putKeyPolicy :: Text -> Text -> Text -> PutKeyPolicy
- data PutKeyPolicy
- pkpBypassPolicyLockoutSafetyCheck :: Lens' PutKeyPolicy (Maybe Bool)
- pkpKeyId :: Lens' PutKeyPolicy Text
- pkpPolicyName :: Lens' PutKeyPolicy Text
- pkpPolicy :: Lens' PutKeyPolicy Text
- putKeyPolicyResponse :: PutKeyPolicyResponse
- data PutKeyPolicyResponse
Creating a Request
Creates a value of PutKeyPolicy
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pkpBypassPolicyLockoutSafetyCheck
- A flag to indicate whether to bypass the key policy lockout safety check. Important: Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide . Use this parameter only when you intend to prevent the principal that is making the request from making a subsequentPutKeyPolicy
request on the CMK. The default value is false.pkpKeyId
- A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: * Key ID:1234abcd-12ab-34cd-56ef-1234567890ab
* Key ARN:arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, useListKeys
orDescribeKey
.pkpPolicyName
- The name of the key policy. The only valid value isdefault
.pkpPolicy
- The key policy to attach to the CMK. If you do not setBypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria: * It must allow the principal that is making thePutKeyPolicy
request to make a subsequentPutKeyPolicy
request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide . * The principals that are specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide . The policy size limit is 32 kilobytes (32768 bytes).
data PutKeyPolicy Source #
See: putKeyPolicy
smart constructor.
Request Lenses
pkpBypassPolicyLockoutSafetyCheck :: Lens' PutKeyPolicy (Maybe Bool) Source #
A flag to indicate whether to bypass the key policy lockout safety check. Important: Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide . Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy
request on the CMK. The default value is false.
pkpKeyId :: Lens' PutKeyPolicy Text Source #
A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys
or DescribeKey
.
pkpPolicyName :: Lens' PutKeyPolicy Text Source #
The name of the key policy. The only valid value is default
.
pkpPolicy :: Lens' PutKeyPolicy Text Source #
The key policy to attach to the CMK. If you do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria: * It must allow the principal that is making the PutKeyPolicy
request to make a subsequent PutKeyPolicy
request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide . * The principals that are specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide . The policy size limit is 32 kilobytes (32768 bytes).
Destructuring the Response
putKeyPolicyResponse :: PutKeyPolicyResponse Source #
Creates a value of PutKeyPolicyResponse
with the minimum fields required to make a request.
data PutKeyPolicyResponse Source #
See: putKeyPolicyResponse
smart constructor.