Class: Aws::KMS::Types::CreateAliasRequest

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 CreateAliasRequest data as a hash:

{
  alias_name: "AliasNameType", # required
  target_key_id: "KeyIdType", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#alias_name ⇒ String

Specifies the alias name. This value must begin with ‘alias/` followed by the alias name, such as `alias/ExampleAlias`. The alias name cannot begin with `aws/`. The `alias/aws/` prefix is reserved for AWS managed CMKs.

Returns:

  • (String) 


111
112
113
114
115
 
# File 'lib/aws-sdk-kms/types.rb', line 111

class CreateAliasRequest < Struct.new(
  :alias_name,
  :target_key_id)
  include Aws::Structure
end

#target_key_id ⇒ String

Identifies the CMK for which you are creating the alias. This value cannot be an alias.

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) 


111
112
113
114
115
 
# File 'lib/aws-sdk-kms/types.rb', line 111

class CreateAliasRequest < Struct.new(
  :alias_name,
  :target_key_id)
  include Aws::Structure
end