Class: Aws::KMS::Types::PutKeyPolicyRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kms/types.rb

Overview

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,
}

See Also:

Instance Attribute Summary collapse

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 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.

[1]: docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam

Returns:

  • (Boolean) 


1902
1903
1904
1905
1906
1907
1908
 
# File 'lib/aws-sdk-kms/types.rb', line 1902

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 CMK.

Use the CMK’s unique identifier or its Amazon Resource Name (ARN). For example:

  • Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Returns:

  • (String) 


1902
1903
1904
1905
1906
1907
1908
 
# File 'lib/aws-sdk-kms/types.rb', line 1902

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.

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 KiB (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

Returns:

  • (String) 


1902
1903
1904
1905
1906
1907
1908
 
# File 'lib/aws-sdk-kms/types.rb', line 1902

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.

This value must be ‘default`.

Returns:

  • (String) 


1902
1903
1904
1905
1906
1907
1908
 
# File 'lib/aws-sdk-kms/types.rb', line 1902

class PutKeyPolicyRequest < Struct.new(
  :key_id,
  :policy_name,
  :policy,
  :bypass_policy_lockout_safety_check)
  include Aws::Structure
end