Package software.amazon.awscdk.services.paymentcryptography

Class CfnKey.Builder

java.lang.Object

software.amazon.awscdk.services.paymentcryptography.CfnKey.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnKey>

Enclosing class:

CfnKey

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

A fluent builder for CfnKey.

Method Summary

Modifier and Type	Method	Description
CfnKey	build()
static CfnKey.Builder	create(software.constructs.Construct scope, String id)
CfnKey.Builder	enabled(Boolean enabled)	Specifies whether the key is enabled.
CfnKey.Builder	enabled(IResolvable enabled)	Specifies whether the key is enabled.
CfnKey.Builder	exportable(Boolean exportable)	Specifies whether the key is exportable.
CfnKey.Builder	exportable(IResolvable exportable)	Specifies whether the key is exportable.
CfnKey.Builder	keyAttributes(IResolvable keyAttributes)	The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.
CfnKey.Builder	keyAttributes(CfnKey.KeyAttributesProperty keyAttributes)	The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.
CfnKey.Builder	keyCheckValueAlgorithm(String keyCheckValueAlgorithm)	The algorithm that AWS Payment Cryptography uses to calculate the key check value (KCV).
CfnKey.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 CfnKey.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnKey.Builder.

exportable

@Stability(Stable)
public CfnKey.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 CfnKey.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 CfnKey.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 CfnKey.Builder keyAttributes(CfnKey.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

enabled

@Stability(Stable)
public CfnKey.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 CfnKey.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

keyCheckValueAlgorithm

@Stability(Stable)
public CfnKey.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

tags

@Stability(Stable)
public CfnKey.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 CfnKey build()

Specified by:

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

Returns:

a newly built instance of CfnKey.