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

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

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#alias_nameString

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

Returns:

  • (String)


280
281
282
283
284
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 280

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

#target_key_idString

Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.

Returns:

  • (String)


280
281
282
283
284
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 280

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