AWSKMSCreateAliasRequest

Objective-C

@interface AWSKMSCreateAliasRequest

Swift

class AWSKMSCreateAliasRequest

  • 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 AWS managed CMKs.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable aliasName;

    Swift

    var aliasName: String? { get set }

  • Associates the alias with the specified customer managed CMK. The CMK must be in the same AWS Region.

    A valid CMK 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 AWS Key Management Service Developer Guide.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    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 CMK, use ListKeys or DescribeKey.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable targetKeyId;

    Swift

    var targetKeyId: String? { get set }