Package software.amazon.awssdk.services.paymentcryptography.model

Interface Key.Builder

    • Method Detail

      • createTimestamp

        Key.Builder createTimestamp​(Instant createTimestamp)

        The date and time when the key was created.

        Parameters:
        createTimestamp - The date and time when the key was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deletePendingTimestamp

        Key.Builder deletePendingTimestamp​(Instant deletePendingTimestamp)

        The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.

        Parameters:
        deletePendingTimestamp - The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deleteTimestamp

        Key.Builder deleteTimestamp​(Instant deleteTimestamp)

        The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.

        Parameters:
        deleteTimestamp - The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enabled

        Key.Builder enabled​(Boolean enabled)

        Specifies whether the key is enabled.

        Parameters:
        enabled - Specifies whether the key is enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • exportable

        Key.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 data is immutable after the key is created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyArn

        Key.Builder keyArn​(String keyArn)

        The Amazon Resource Name (ARN) of the key.

        Parameters:
        keyArn - The Amazon Resource Name (ARN) of the key.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyAttributes

        Key.Builder keyAttributes​(KeyAttributes 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 data is immutable after the key is created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyCheckValue

        Key.Builder keyCheckValue​(String keyCheckValue)

        The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

        Parameters:
        keyCheckValue - The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyCheckValueAlgorithm

        Key.Builder keyCheckValueAlgorithm​(String keyCheckValueAlgorithm)

        The algorithm used for calculating key check value (KCV) for DES and AES keys. For a DES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For an AES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.

        Parameters:
        keyCheckValueAlgorithm - The algorithm used for calculating key check value (KCV) for DES and AES keys. For a DES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For an AES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '01', with the key to be checked 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, KeyCheckValueAlgorithm

      • keyCheckValueAlgorithm

        Key.Builder keyCheckValueAlgorithm​(KeyCheckValueAlgorithm keyCheckValueAlgorithm)

        The algorithm used for calculating key check value (KCV) for DES and AES keys. For a DES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For an AES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.

        Parameters:
        keyCheckValueAlgorithm - The algorithm used for calculating key check value (KCV) for DES and AES keys. For a DES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For an AES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '01', with the key to be checked 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, KeyCheckValueAlgorithm

      • keyOrigin

        Key.Builder keyOrigin​(String keyOrigin)

        The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.

        Parameters:
        keyOrigin - The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KeyOrigin, KeyOrigin

      • keyOrigin

        Key.Builder keyOrigin​(KeyOrigin keyOrigin)

        The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.

        Parameters:
        keyOrigin - The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KeyOrigin, KeyOrigin

      • keyState

        Key.Builder keyState​(String keyState)

        The state of key that is being created or deleted.

        Parameters:
        keyState - The state of key that is being created or deleted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KeyState, KeyState

      • keyState

        Key.Builder keyState​(KeyState keyState)

        The state of key that is being created or deleted.

        Parameters:
        keyState - The state of key that is being created or deleted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KeyState, KeyState

      • usageStartTimestamp

        Key.Builder usageStartTimestamp​(Instant usageStartTimestamp)

        The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.

        Parameters:
        usageStartTimestamp - The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • usageStopTimestamp

        Key.Builder usageStopTimestamp​(Instant usageStopTimestamp)

        The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.

        Parameters:
        usageStopTimestamp - The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.
        Returns:
        Returns a reference to this object so that method calls can be chained together.