class Aws::KMS::Types::CreateAliasRequest
@note When making an API call, you may pass CreateAliasRequest
data as a hash: { alias_name: "AliasNameType", # required target_key_id: "KeyIdType", # required }
@!attribute [rw] alias_name
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][1]. [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk @return [String]
@!attribute [rw] target_key_id
Associates the alias with the specified [customer managed key][1]. 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][2] in the <i> <i>Key Management Service Developer Guide</i> </i>. 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. [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk [2]: https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn @return [String]
@see docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateAliasRequest AWS API Documentation
Constants
- SENSITIVE