Package software.amazon.awscdk.cfnpropertymixins.services.paymentcryptography

Class CfnKeyPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.paymentcryptography.CfnKeyPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnKeyPropsMixin>

Enclosing class:

CfnKeyPropsMixin

@Stability(Stable)
public static final class CfnKeyPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnKeyPropsMixin>

A fluent builder for CfnKeyPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnKeyPropsMixin	build()
static CfnKeyPropsMixin.Builder	create()
static CfnKeyPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnKeyPropsMixin.Builder	deriveKeyUsage(String deriveKeyUsage)	The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec.
CfnKeyPropsMixin.Builder	enabled(Boolean enabled)	Specifies whether the key is enabled.
CfnKeyPropsMixin.Builder	enabled(IResolvable enabled)	Specifies whether the key is enabled.
CfnKeyPropsMixin.Builder	exportable(Boolean exportable)	Specifies whether the key is exportable.
CfnKeyPropsMixin.Builder	exportable(IResolvable exportable)	Specifies whether the key is exportable.
CfnKeyPropsMixin.Builder	keyAttributes(CfnKeyPropsMixin.KeyAttributesProperty keyAttributes)	The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.
CfnKeyPropsMixin.Builder	keyAttributes(IResolvable keyAttributes)	The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.
CfnKeyPropsMixin.Builder	keyCheckValueAlgorithm(String keyCheckValueAlgorithm)	The algorithm that AWS Payment Cryptography uses to calculate the key check value (KCV).
CfnKeyPropsMixin.Builder	replicationRegions(List<String> replicationRegions)	The list of AWS Regions to remove from the key's replication configuration.
CfnKeyPropsMixin.Builder	tags(List<? extends CfnTag> tags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnKeyPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnKeyPropsMixin.Builder.

create

@Stability(Stable)
public static CfnKeyPropsMixin.Builder create()

Returns:

a new instance of CfnKeyPropsMixin.Builder.

deriveKeyUsage

@Stability(Stable)
public CfnKeyPropsMixin.Builder deriveKeyUsage(String deriveKeyUsage)

The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec.

Parameters:

deriveKeyUsage - The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec. This parameter is required.

Returns:

this

See Also:

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

enabled

@Stability(Stable)
public CfnKeyPropsMixin.Builder enabled(Boolean enabled)

Specifies whether the key is enabled.

Parameters:

enabled - Specifies whether the key is enabled. This parameter is required.

Returns:

this

See Also:

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

enabled

@Stability(Stable)
public CfnKeyPropsMixin.Builder enabled(IResolvable enabled)

Specifies whether the key is enabled.

Parameters:

enabled - Specifies whether the key is enabled. This parameter is required.

Returns:

this

See Also:

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

exportable

@Stability(Stable)
public CfnKeyPropsMixin.Builder exportable(Boolean exportable)

Specifies whether the key is exportable.

This data is immutable after the key is created.

Parameters:

exportable - Specifies whether the key is exportable. This parameter is required.

Returns:

this

See Also:

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

exportable

@Stability(Stable)
public CfnKeyPropsMixin.Builder exportable(IResolvable exportable)

Specifies whether the key is exportable.

This data is immutable after the key is created.

Parameters:

exportable - Specifies whether the key is exportable. This parameter is required.

Returns:

this

See Also:

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

keyAttributes

@Stability(Stable)
public CfnKeyPropsMixin.Builder keyAttributes(IResolvable keyAttributes)

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.

Parameters:

keyAttributes - The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This parameter is required.

Returns:

this

See Also:

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

keyAttributes

@Stability(Stable)
public CfnKeyPropsMixin.Builder keyAttributes(CfnKeyPropsMixin.KeyAttributesProperty keyAttributes)

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.

Parameters:

keyAttributes - The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This parameter is required.

Returns:

this

See Also:

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

keyCheckValueAlgorithm

@Stability(Stable)
public CfnKeyPropsMixin.Builder keyCheckValueAlgorithm(String keyCheckValueAlgorithm)

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.

Parameters:

keyCheckValueAlgorithm - The algorithm that AWS Payment Cryptography uses to calculate the key check value (KCV). This parameter is required.

Returns:

this

See Also:

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

replicationRegions

@Stability(Stable)
public CfnKeyPropsMixin.Builder replicationRegions(List<String> replicationRegions)

The list of AWS Regions to remove from the key's replication configuration.

The key will no longer be available for cryptographic operations in these regions after removal. Ensure no active operations depend on the key in these regions before removal.

Parameters:

replicationRegions - The list of AWS Regions to remove from the key's replication configuration. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnKeyPropsMixin.Builder tags(List<? extends CfnTag> tags)

Parameters:

tags - This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnKeyPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnKeyPropsMixin>

Returns:

a newly built instance of CfnKeyPropsMixin.