AWS::PaymentCryptography::Alias - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::PaymentCryptography::Alias

Creates an alias, or a friendly name, for an AWS Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData.

You can associate the alias with any key in the same AWS Region. Each alias is associated with only one key at a time, but a key can have multiple aliases. You can't create an alias without a key. The alias must be unique in the account and AWS Region, but you can create another alias with the same name in a different AWS Region.

To change the key that's associated with the alias, call UpdateAlias. To delete the alias, call DeleteAlias. These operations don't affect the underlying key. To get the alias that you created, call ListAliases.

Cross-account use: This operation can't be used across different AWS accounts.

Related operations:

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::PaymentCryptography::Alias",
  "Properties" : {
      "AliasName" : String,
      "KeyArn" : String
    }
}

YAML

Type: AWS::PaymentCryptography::Alias
Properties:
  AliasName: String
  KeyArn: String

Properties

AliasName

A friendly name that you can use to refer to a key. The value must begin with alias/.

Important

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in AWS CloudTrail logs and other output.

Required: Yes

Type: String

Pattern: ^alias/[a-zA-Z0-9/_-]+$

Minimum: 7

Maximum: 256

Update requires: Replacement

KeyArn

The KeyARN of the key associated with the alias.

Required: No

Type: String

Pattern: ^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$

Minimum: 70

Maximum: 150

Update requires: No interruption

Return values

Ref