- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateAliasCommand
Creates a friendly name for a KMS key.
Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.
You can use an alias to identify a KMS key in the KMS console, in the DescribeKey operation and in cryptographic operations , such as Encrypt and GenerateDataKey. You can also change the KMS key that's associated with the alias (UpdateAlias) or delete the alias (DeleteAlias) at any time. These operations don't affect the underlying KMS key.
You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases. A valid KMS key is required. You can't create an alias without a KMS key.
The alias must be unique in the account and Region, but you can have aliases with the same name in different Regions. For detailed information about aliases, see Using aliases in the Key Management Service Developer Guide.
This operation does not return a response. To get the alias that you created, use the ListAliases operation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.
Required permissions
-
kms:CreateAlias on the alias (IAM policy).
-
kms:CreateAlias on the KMS key (key policy).
For details, see Controlling access to aliases in the Key Management Service Developer Guide.
Related operations:
-
DeleteAlias
-
ListAliases
-
UpdateAlias
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency .
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { KMSClient, CreateAliasCommand } from "@aws-sdk/client-kms"; // ES Modules import
// const { KMSClient, CreateAliasCommand } = require("@aws-sdk/client-kms"); // CommonJS import
const client = new KMSClient(config);
const input = { // CreateAliasRequest
AliasName: "STRING_VALUE", // required
TargetKeyId: "STRING_VALUE", // required
};
const command = new CreateAliasCommand(input);
const response = await client.send(command);
// {};
Example Usage
CreateAliasCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
AliasNameRequired | string | undefined | Specifies the alias name. This value must begin with Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output. The |
TargetKeyIdRequired | string | undefined | 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:
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. |
CreateAliasCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AlreadyExistsException | client | The request was rejected because it attempted to create a resource that already exists. |
| DependencyTimeoutException | server | The system timed out while trying to fulfill the request. You can retry the request. |
| InvalidAliasNameException | client | The request was rejected because the specified alias name is not valid. |
| KMSInternalException | server | The request was rejected because an internal exception occurred. The request can be retried. |
| KMSInvalidStateException | client | The request was rejected because the state of the specified resource is not valid for this request. This exceptions means one of the following:
|
| LimitExceededException | client | The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide. |
| NotFoundException | client | The request was rejected because the specified entity or resource could not be found. |
| KMSServiceException | Base exception class for all service exceptions from KMS service. |