Class: Aws::KMS::Types::GetKeyPolicyRequest

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::GetKeyPolicyRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kms/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #key_id ⇒ String

  Gets the key policy for the specified KMS key.

• #policy_name ⇒ String

  Specifies the name of the key policy.

Instance Attribute Details

#key_id ⇒ String

Gets the key policy for 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)

# File 'lib/aws-sdk-kms/types.rb', line 3293

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

#policy_name ⇒ String

Specifies the name of the key policy. If no policy name is specified, the default value is ‘default`. The only valid name is `default`. To get the names of key policies, use ListKeyPolicies.

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 3293

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