AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 
Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).

The alias and the key it is mapped to must be in the same AWS account and the same region.

To map an alias to a different key, call UpdateAlias.

Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public virtual CreateAliasResponse CreateAlias(
         String aliasName,
         String targetKeyId
)

Parameters

aliasName
Type: System.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.

targetKeyId
Type: System.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-123456789012Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Return Value
Type: Amazon.KeyManagementService.Model.CreateAliasResponse
The response from the CreateAlias service method, as returned by KeyManagementService.

Exceptions

ExceptionCondition
AlreadyExistsException The request was rejected because it attempted to create a resource that already exists.
DependencyTimeoutException The system timed out while trying to fulfill the request. The request can be retried.
InvalidAliasNameException The request was rejected because the specified alias name is not valid.
KMSInternalException The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException The request was rejected because the state of the specified resource is not valid for this request. For more information about how key state affects the use of a customer master key (CMK), go to How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
LimitExceededException The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
NotFoundException The request was rejected because the specified entity or resource could not be found.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5