Class: Aws::KMS::Types::CreateAliasRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::CreateAliasRequest
- Includes:
- Structure
- Defined in:
- 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
-
#alias_name ⇒ String
String that contains the display name.
-
#target_key_id ⇒ String
An identifier of the key for which you are creating the alias.
Instance Attribute Details
#alias_name ⇒ String
String that contains the display name. The name must start with the word “alias” followed by a forward slash (alias/). Aliases that begin with “alias/AWS” are reserved.
104 105 106 107 108 |
# File 'lib/aws-sdk-kms/types.rb', line 104 class CreateAliasRequest < Struct.new( :alias_name, :target_key_id) include Aws::Structure end |
#target_key_id ⇒ String
An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to 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
104 105 106 107 108 |
# File 'lib/aws-sdk-kms/types.rb', line 104 class CreateAliasRequest < Struct.new( :alias_name, :target_key_id) include Aws::Structure end |