Package software.amazon.awscdk.services.paymentcryptography

Class CfnAlias

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.paymentcryptography.CfnAlias
All Implemented Interfaces:
IInspectable, IAliasRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:44.456Z") @Stability(Stable) public class CfnAlias extends CfnResource implements IInspectable, IAliasRef
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:

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.paymentcryptography.*;
 CfnAlias cfnAlias = CfnAlias.Builder.create(this, "MyCfnAlias")
         .aliasName("aliasName")
         // the properties below are optional
         .keyArn("keyArn")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAlias

      protected CfnAlias(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAlias

      protected CfnAlias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAlias

      @Stability(Stable) public CfnAlias(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAliasProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAliasRef

      @Stability(Stable) @NotNull public AliasReference getAliasRef()
      A reference to a Alias resource.
      Specified by:
      getAliasRef in interface IAliasRef

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAliasName

      @Stability(Stable) @NotNull public String getAliasName()
      A friendly name that you can use to refer to a key.

      The value must begin with alias/ .

    • setAliasName

      @Stability(Stable) public void setAliasName(@NotNull String value)
      A friendly name that you can use to refer to a key.

      The value must begin with alias/ .

    • getKeyArn

      @Stability(Stable) @Nullable public String getKeyArn()
      The KeyARN of the key associated with the alias.

    • setKeyArn

      @Stability(Stable) public void setKeyArn(@Nullable String value)
      The KeyARN of the key associated with the alias.