class Aws::KMS::Types::PutKeyPolicyRequest
@note When making an API call, you may pass PutKeyPolicyRequest
data as a hash: { key_id: "KeyIdType", # required policy_name: "PolicyNameType", # required policy: "PolicyType", # required bypass_policy_lockout_safety_check: false, }
@!attribute [rw] key_id
Sets the key policy on the specified KMS key. Specify the key ID or key ARN of the KMS key. 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 KMS key, use ListKeys or DescribeKey. @return [String]
@!attribute [rw] policy_name
The name of the key policy. The only valid value is `default`. @return [String]
@!attribute [rw] policy
The key policy to attach to the KMS key. The key policy must meet the following criteria: * If you don't set `BypassPolicyLockoutSafetyCheck` to true, the key policy must allow the principal that is making the `PutKeyPolicy` request to make a subsequent `PutKeyPolicy` request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the [Default Key Policy][1] section of the *Key Management Service Developer Guide*. * Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible][2] in the *Amazon Web Services Identity and Access Management User Guide*. The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see [Resource Quotas][3] in the *Key Management Service Developer Guide*. [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency [3]: https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html @return [String]
@!attribute [rw] bypass_policy_lockout_safety_check
A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the [Default Key Policy][1] section in the *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 KMS key. The default value is false. [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam @return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/PutKeyPolicyRequest AWS API Documentation
Constants
- SENSITIVE