class CfnAliasPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.PaymentCryptography.Mixins.CfnAliasPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awspaymentcryptography/mixins#CfnAliasPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.paymentcryptography.mixins.CfnAliasPropsMixin
Python	aws_cdk.mixins_preview.aws_paymentcryptography.mixins.CfnAliasPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_paymentcryptography » mixins » CfnAliasPropsMixin

Implements IMixin

Extends Mixin

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:

• DeleteAlias
• GetAlias
• ListAliases
• UpdateAlias

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-alias.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as paymentcryptography_mixins } from '@aws-cdk/mixins-preview/aws-paymentcryptography';
const cfnAliasPropsMixin = new paymentcryptography_mixins.CfnAliasPropsMixin({
  aliasName: 'aliasName',
  keyArn: 'keyArn',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnAliasPropsMixin(props: CfnAliasMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnAliasMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::PaymentCryptography::Alias.

Properties

Name	Type	Description
props	CfnAliasMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnAliasMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.