AWSKMSUpdateAliasRequest

Objective-C

@interface AWSKMSUpdateAliasRequest

Swift

class AWSKMSUpdateAliasRequest
  • Identifies the alias that is changing its CMK. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

    Declaration

    Objective-C

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

    Swift

    var aliasName: String? { get set }
  • Identifies the CMK to associate with the alias. When the update operation completes, the alias will point to this CMK.

    The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.

    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.

    To verify that the alias is mapped to the correct CMK, use ListAliases.

    Declaration

    Objective-C

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

    Swift

    var targetKeyId: String? { get set }