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

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

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#alias_nameString

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)


2254
2255
2256
2257
2258
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2254

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

#target_key_idString

Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

Returns:

  • (String)


2254
2255
2256
2257
2258
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2254

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