CfnAliasPropsMixin

class aws_cdk.mixins_preview.aws_paymentcryptography.mixins.CfnAliasPropsMixin(props, *, strategy=None)

Bases: 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:

See:

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

CloudformationResource:

AWS::PaymentCryptography::Alias

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_paymentcryptography import mixins as paymentcryptography_mixins

cfn_alias_props_mixin = paymentcryptography_mixins.CfnAliasPropsMixin(paymentcryptography_mixins.CfnAliasMixinProps(
    alias_name="aliasName",
    key_arn="keyArn"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

  • props (Union[CfnAliasMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['aliasName', 'keyArn']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental