Interface WrappedKey.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WrappedKey.Builder,WrappedKey>, SdkBuilder<WrappedKey.Builder,WrappedKey>, SdkPojo
Enclosing class:
WrappedKey
@Mutable @NotThreadSafe public static interface WrappedKey.Builder extends SdkPojo, CopyableBuilder<WrappedKey.Builder,WrappedKey>

  • Method Details

    • wrappedKeyMaterial

      WrappedKey.Builder wrappedKeyMaterial(WrappedKeyMaterial wrappedKeyMaterial)

      Parameter information of a WrappedKeyBlock for encryption key exchange.

      Parameters:
      wrappedKeyMaterial - Parameter information of a WrappedKeyBlock for encryption key exchange.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • wrappedKeyMaterial

      default WrappedKey.Builder wrappedKeyMaterial(Consumer<WrappedKeyMaterial.Builder> wrappedKeyMaterial)

      Parameter information of a WrappedKeyBlock for encryption key exchange.

      This is a convenience method that creates an instance of the WrappedKeyMaterial.Builder avoiding the need to create one manually via WrappedKeyMaterial.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to wrappedKeyMaterial(WrappedKeyMaterial).

      Parameters:
      wrappedKeyMaterial - a consumer that will call methods on WrappedKeyMaterial.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • keyCheckValueAlgorithm

      WrappedKey.Builder keyCheckValueAlgorithm(String keyCheckValueAlgorithm)

      The algorithm that Amazon Web Services 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 Amazon Web Services 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • keyCheckValueAlgorithm

      WrappedKey.Builder keyCheckValueAlgorithm(KeyCheckValueAlgorithm keyCheckValueAlgorithm)

      The algorithm that Amazon Web Services 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 Amazon Web Services 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also: