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 Details

    • Builder

      public Builder()
  • Method Details

    • exportable

      @Stability(Stable) public CfnKeyProps.Builder exportable(Boolean exportable)
      Sets the value of CfnKeyProps.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

      @Stability(Stable) public CfnKeyProps.Builder exportable(IResolvable exportable)
      Sets the value of CfnKeyProps.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

      @Stability(Stable) public CfnKeyProps.Builder keyAttributes(IResolvable keyAttributes)
      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)
      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
    • enabled

      @Stability(Stable) public CfnKeyProps.Builder enabled(Boolean enabled)
      Sets the value of CfnKeyProps.getEnabled()
      Parameters:
      enabled - Specifies whether the key is enabled.
      Returns:
      this
    • enabled

      @Stability(Stable) public CfnKeyProps.Builder enabled(IResolvable enabled)
      Sets the value of CfnKeyProps.getEnabled()
      Parameters:
      enabled - Specifies whether the key is enabled.
      Returns:
      this
    • keyCheckValueAlgorithm

      @Stability(Stable) public CfnKeyProps.Builder keyCheckValueAlgorithm(String keyCheckValueAlgorithm)
      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

      @Stability(Stable) public CfnKeyProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnKeyProps.getTags()
      Parameters:
      tags - the value to be set.
      Returns:
      this
    • build

      @Stability(Stable) public CfnKeyProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnKeyProps>
      Returns:
      a new instance of CfnKeyProps
      Throws:
      NullPointerException - if any required attribute was not provided