You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kms/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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#bypass_policy_lockout_safety_checkBoolean

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.

Returns:

  • (Boolean)


2000
2001
2002
2003
2004
2005
2006
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2000

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

#key_idString

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.

Returns:

  • (String)


2000
2001
2002
2003
2004
2005
2006
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2000

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

#policyString

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

Returns:

  • (String)


2000
2001
2002
2003
2004
2005
2006
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2000

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

#policy_nameString

The name of the key policy. The only valid value is default.

Returns:

  • (String)


2000
2001
2002
2003
2004
2005
2006
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2000

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