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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bypass_policy_lockout_safety_check ⇒ Boolean

Skips ("bypasses") the key policy lockout safety check. The default value is false.

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, see Default key policy 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.

Returns:

  • (Boolean) 


5074
5075
5076
5077
5078
5079
5080
5081
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5074

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

#key_id ⇒ String

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.

Returns:

  • (String) 


5074
5075
5076
5077
5078
5079
5080
5081
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5074

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

#policy ⇒ String

The key policy to attach to the KMS key.

The key policy must meet the following criteria:

  • The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)

  • 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, 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 in the Amazon Web Services Identity and Access Management User Guide.

A key policy document can include only the following characters:

  • Printable ASCII characters from the space character (\u0020) through the end of the ASCII character range.

  • Printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF).

  • The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide.For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .

Returns:

  • (String) 


5074
5075
5076
5077
5078
5079
5080
5081
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5074

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

#policy_name ⇒ String

The name of the key policy. If no policy name is specified, the default value is default. The only valid value is default.

Returns:

  • (String) 


5074
5075
5076
5077
5078
5079
5080
5081
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5074

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