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

Inherits:

Struct

Object
Struct
Aws::KMS::Types::CreateAliasRequest

show all

Defined in:: gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#alias_name ⇒ String
Specifies the alias name.
#target_key_id ⇒ String
Associates the alias with the specified [customer managed key][1].

Instance Attribute Details

#alias_name ⇒ `String`

Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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)

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

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

#target_key_id ⇒ `String`

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.