Class CfnKeyProps.Builder
java.lang.Object
software.amazon.awscdk.services.paymentcryptography.CfnKeyProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnKeyProps>
- Enclosing interface:
CfnKeyProps
@Stability(Stable)
public static final class CfnKeyProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnKeyProps>
A builder for
CfnKeyProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.deriveKeyUsage(String deriveKeyUsage) Sets the value ofCfnKeyProps.getDeriveKeyUsage()Sets the value ofCfnKeyProps.getEnabled()enabled(IResolvable enabled) Sets the value ofCfnKeyProps.getEnabled()exportable(Boolean exportable) Sets the value ofCfnKeyProps.getExportable()exportable(IResolvable exportable) Sets the value ofCfnKeyProps.getExportable()keyAttributes(IResolvable keyAttributes) Sets the value ofCfnKeyProps.getKeyAttributes()keyAttributes(CfnKey.KeyAttributesProperty keyAttributes) Sets the value ofCfnKeyProps.getKeyAttributes()keyCheckValueAlgorithm(String keyCheckValueAlgorithm) Sets the value ofCfnKeyProps.getKeyCheckValueAlgorithm()Sets the value ofCfnKeyProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
exportable
Sets the value ofCfnKeyProps.getExportable()- Parameters:
exportable- Specifies whether the key is exportable. This parameter is required. This data is immutable after the key is created.- Returns:
this
-
exportable
Sets the value ofCfnKeyProps.getExportable()- Parameters:
exportable- Specifies whether the key is exportable. This parameter is required. This data is immutable after the key is created.- Returns:
this
-
keyAttributes
Sets the value ofCfnKeyProps.getKeyAttributes()- Parameters:
keyAttributes- The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This parameter is required. This data is immutable after the key is created.- Returns:
this
-
keyAttributes
@Stability(Stable) public CfnKeyProps.Builder keyAttributes(CfnKey.KeyAttributesProperty keyAttributes) Sets the value ofCfnKeyProps.getKeyAttributes()- Parameters:
keyAttributes- The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This parameter is required. This data is immutable after the key is created.- Returns:
this
-
deriveKeyUsage
Sets the value ofCfnKeyProps.getDeriveKeyUsage()- Parameters:
deriveKeyUsage- The cryptographic usage of an ECDH derived key as deļ¬ned in section A.5.2 of the TR-31 spec.- Returns:
this
-
enabled
Sets the value ofCfnKeyProps.getEnabled()- Parameters:
enabled- Specifies whether the key is enabled.- Returns:
this
-
enabled
Sets the value ofCfnKeyProps.getEnabled()- Parameters:
enabled- Specifies whether the key is enabled.- Returns:
this
-
keyCheckValueAlgorithm
Sets the value ofCfnKeyProps.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
-
tags
Sets the value ofCfnKeyProps.getTags()- Parameters:
tags- the value to be set.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnKeyProps>- Returns:
- a new instance of
CfnKeyProps - Throws:
NullPointerException- if any required attribute was not provided
-