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

Interface CreateKeyRequest.Builder

    • Method Detail

      • enabled

        CreateKeyRequest.Builder enabled​(Boolean enabled)

        Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled.

        Parameters:
        enabled - Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • exportable

        CreateKeyRequest.Builder exportable​(Boolean exportable)

        Specifies whether the key is exportable from the service.

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

      • keyAttributes

        CreateKeyRequest.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.

      • keyCheckValueAlgorithm

        CreateKeyRequest.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, KeyCheckValueAlgorithm

      • keyCheckValueAlgorithm

        CreateKeyRequest.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:
        KeyCheckValueAlgorithm, KeyCheckValueAlgorithm

      • tags

        CreateKeyRequest.Builder tags​(Collection<Tag> tags)

        Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.

        Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

        Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

        Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

        Parameters:
        tags - Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.

        Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

        Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

        Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

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

      • tags

        CreateKeyRequest.Builder tags​(Tag... tags)

        Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.

        Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

        Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

        Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

        Parameters:
        tags - Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.

        Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

        Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

        Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

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

      • tags

        CreateKeyRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.

        Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

        Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

        Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)