Class: Aws::KMS::Types::PutKeyPolicyRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::PutKeyPolicyRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-kms/types.rb
Overview
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,
}
Instance Attribute Summary collapse
-
#bypass_policy_lockout_safety_check ⇒ Boolean
A flag to indicate whether to bypass the key policy lockout safety check.
-
#key_id ⇒ String
A unique identifier for the customer master key (CMK).
-
#policy ⇒ String
The key policy to attach to the CMK.
-
#policy_name ⇒ String
The name of the key policy.
Instance Attribute Details
#bypass_policy_lockout_safety_check ⇒ Boolean
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk 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.
2023 2024 2025 2026 2027 2028 2029 |
# File 'lib/aws-sdk-kms/types.rb', line 2023 class PutKeyPolicyRequest < Struct.new( :key_id, :policy_name, :policy, :bypass_policy_lockout_safety_check) include Aws::Structure end |
#key_id ⇒ String
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.
2023 2024 2025 2026 2027 2028 2029 |
# File 'lib/aws-sdk-kms/types.rb', line 2023 class PutKeyPolicyRequest < Struct.new( :key_id, :policy_name, :policy, :bypass_policy_lockout_safety_check) include Aws::Structure end |
#policy ⇒ String
The key policy to attach to the CMK.
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 CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the
- Default Key Policy][1
-
section of the *AWS 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 AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy. The reason for this is that the new principal might not be immediately visible to AWS KMS. For more information, see [Changes that I make are not always immediately visible] in the *AWS Identity and Access Management User Guide*.
The key policy size limit is 32 kilobytes (32768 bytes).
[1]: docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam [2]: docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
2023 2024 2025 2026 2027 2028 2029 |
# File 'lib/aws-sdk-kms/types.rb', line 2023 class PutKeyPolicyRequest < Struct.new( :key_id, :policy_name, :policy, :bypass_policy_lockout_safety_check) include Aws::Structure end |
#policy_name ⇒ String
The name of the key policy. The only valid value is ‘default`.
2023 2024 2025 2026 2027 2028 2029 |
# File 'lib/aws-sdk-kms/types.rb', line 2023 class PutKeyPolicyRequest < Struct.new( :key_id, :policy_name, :policy, :bypass_policy_lockout_safety_check) include Aws::Structure end |