Class: Aws::KMS::Types::UpdateAliasRequest

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::UpdateAliasRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kms/types.rb

Overview

Note:

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

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

See Also:

• AWS API Documentation

Instance Attribute Summary

• #alias_name ⇒ String

  String that contains the name of the alias to be modified.

• #target_key_id ⇒ String

  Unique identifier of the customer master key to be mapped to the alias.

Instance Attribute Details

#alias_name ⇒ String

String that contains the name of the alias to be modified. The name must start with the word “alias” followed by a forward slash (alias/). Aliases that begin with “alias/aws” are reserved.

Returns:

• (String)

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

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

#target_key_id ⇒ String

Unique identifier of the customer master key to be mapped to the 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.

To verify that the alias is mapped to the correct CMK, use ListAliases.

Returns:

• (String)

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

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