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

Interface KeyBlockHeaders.Builder

    • Method Detail

      • keyModesOfUse

        KeyBlockHeaders.Builder keyModesOfUse​(KeyModesOfUse keyModesOfUse)
        Sets the value of the KeyModesOfUse property for this object.
        Parameters:
        keyModesOfUse - The new value for the KeyModesOfUse property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyExportability

        KeyBlockHeaders.Builder keyExportability​(String keyExportability)

        Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.

        When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.

        Parameters:
        keyExportability - Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.

        When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KeyExportability, KeyExportability

      • keyExportability

        KeyBlockHeaders.Builder keyExportability​(KeyExportability keyExportability)

        Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.

        When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.

        Parameters:
        keyExportability - Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.

        When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KeyExportability, KeyExportability

      • keyVersion

        KeyBlockHeaders.Builder keyVersion​(String keyVersion)

        Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.

        Parameters:
        keyVersion - Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionalBlocks

        KeyBlockHeaders.Builder optionalBlocks​(Map<String,​String> optionalBlocks)

        Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.

        Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.

        Parameters:
        optionalBlocks - Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.

        Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.

        Returns:
        Returns a reference to this object so that method calls can be chained together.