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
}

Constant Summary collapse

SENSITIVE =
[]

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 AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

Returns:

  • (String)


329
330
331
332
333
334
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 329

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

#target_key_idString

Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide .

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)


329
330
331
332
333
334
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 329

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