We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
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.
Specifies the alias name. This value must begin with
alias/followed by a name, such asalias/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
AliasNamevalue must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin withalias/aws/. Thealias/aws/prefix is reserved for Amazon Web Services managed keys.