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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-kms/types.rb

Overview

Note:

When making an API call, you may pass GetKeyPolicyRequest data as a hash:

{
  key_id: "KeyIdType", # required
  policy_name: "PolicyNameType", # required
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #key_id ⇒ String

  A unique identifier for the customer master key.

• #policy_name ⇒ String

  String that contains the name of the policy.

Instance Attribute Details

#key_id ⇒ String

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Returns:

• (String)

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

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

#policy_name ⇒ String

String that contains the name of the policy. Currently, this must be “default”. Policy names can be discovered by calling ListKeyPolicies.

Returns:

• (String)

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

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