CfnKeyProps

class aws_cdk.aws_paymentcryptography.CfnKeyProps(*, exportable, key_attributes, enabled=None, key_check_value_algorithm=None, tags=None)

Bases: object

Properties for defining a CfnKey.

Parameters:

  • exportable (Union[bool, IResolvable]) – Specifies whether the key is exportable. This data is immutable after the key is created.

  • key_attributes (Union[IResolvable, KeyAttributesProperty, Dict[str, Any]]) – The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.

  • enabled (Union[bool, IResolvable, None]) – Specifies whether the key is enabled.

  • key_check_value_algorithm (Optional[str]) – The algorithm that AWS Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) –

See:

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

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 import aws_paymentcryptography as paymentcryptography

cfn_key_props = paymentcryptography.CfnKeyProps(
    exportable=False,
    key_attributes=paymentcryptography.CfnKey.KeyAttributesProperty(
        key_algorithm="keyAlgorithm",
        key_class="keyClass",
        key_modes_of_use=paymentcryptography.CfnKey.KeyModesOfUseProperty(
            decrypt=False,
            derive_key=False,
            encrypt=False,
            generate=False,
            no_restrictions=False,
            sign=False,
            unwrap=False,
            verify=False,
            wrap=False
        ),
        key_usage="keyUsage"
    ),

    # the properties below are optional
    enabled=False,
    key_check_value_algorithm="keyCheckValueAlgorithm",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

enabled

Specifies whether the key is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#cfn-paymentcryptography-key-enabled

exportable

Specifies whether the key is exportable.

This data is immutable after the key is created.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#cfn-paymentcryptography-key-exportable

key_attributes

The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.

This data is immutable after the key is created.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#cfn-paymentcryptography-key-keyattributes

key_check_value_algorithm

The algorithm that AWS Payment Cryptography uses to calculate the key check value (KCV).

It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#cfn-paymentcryptography-key-keycheckvaluealgorithm

tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#cfn-paymentcryptography-key-tags

Type:

see