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

Class CfnKeyMixinProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnKeyMixinProps>

Enclosing interface:

CfnKeyMixinProps

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

A builder for CfnKeyMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnKeyMixinProps	build()	Builds the configured instance.
CfnKeyMixinProps.Builder	deriveKeyUsage(String deriveKeyUsage)	Sets the value of CfnKeyMixinProps.getDeriveKeyUsage()
CfnKeyMixinProps.Builder	enabled(Boolean enabled)	Sets the value of CfnKeyMixinProps.getEnabled()
CfnKeyMixinProps.Builder	enabled(IResolvable enabled)	Sets the value of CfnKeyMixinProps.getEnabled()
CfnKeyMixinProps.Builder	exportable(Boolean exportable)	Sets the value of CfnKeyMixinProps.getExportable()
CfnKeyMixinProps.Builder	exportable(IResolvable exportable)	Sets the value of CfnKeyMixinProps.getExportable()
CfnKeyMixinProps.Builder	keyAttributes(CfnKeyPropsMixin.KeyAttributesProperty keyAttributes)	Sets the value of CfnKeyMixinProps.getKeyAttributes()
CfnKeyMixinProps.Builder	keyAttributes(IResolvable keyAttributes)	Sets the value of CfnKeyMixinProps.getKeyAttributes()
CfnKeyMixinProps.Builder	keyCheckValueAlgorithm(String keyCheckValueAlgorithm)	Sets the value of CfnKeyMixinProps.getKeyCheckValueAlgorithm()
CfnKeyMixinProps.Builder	replicationRegions(List<String> replicationRegions)	Sets the value of CfnKeyMixinProps.getReplicationRegions()
CfnKeyMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnKeyMixinProps.getTags()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

deriveKeyUsage

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

Sets the value of CfnKeyMixinProps.getDeriveKeyUsage()

Parameters:

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

Returns:

this

enabled

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

Sets the value of CfnKeyMixinProps.getEnabled()

Parameters:

enabled - Specifies whether the key is enabled.

Returns:

this

enabled

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

Sets the value of CfnKeyMixinProps.getEnabled()

Parameters:

enabled - Specifies whether the key is enabled.

Returns:

this

exportable

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

Sets the value of CfnKeyMixinProps.getExportable()

Parameters:

exportable - Specifies whether the key is exportable. This data is immutable after the key is created.

Returns:

this

exportable

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

Sets the value of CfnKeyMixinProps.getExportable()

Parameters:

exportable - Specifies whether the key is exportable. This data is immutable after the key is created.

Returns:

this

keyAttributes

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

Sets the value of CfnKeyMixinProps.getKeyAttributes()

Parameters:

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.

Returns:

this

keyAttributes

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

Sets the value of CfnKeyMixinProps.getKeyAttributes()

Parameters:

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.

Returns:

this

keyCheckValueAlgorithm

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

Sets the value of CfnKeyMixinProps.getKeyCheckValueAlgorithm()

Parameters:

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.

Returns:

this

replicationRegions

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

Sets the value of CfnKeyMixinProps.getReplicationRegions()

Parameters:

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.

Returns:

this

tags

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

Sets the value of CfnKeyMixinProps.getTags()

Parameters:

tags - the value to be set.

Returns:

this

build

@Stability(Stable)
public CfnKeyMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnKeyMixinProps

Throws:

NullPointerException - if any required attribute was not provided