Interface ImportKeyRequest.Builder

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

  • Method Details

    • keyMaterial

      ImportKeyRequest.Builder keyMaterial(ImportKeyMaterial keyMaterial)

      The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.

      Parameters:
      keyMaterial - The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keyMaterial

      default ImportKeyRequest.Builder keyMaterial(Consumer<ImportKeyMaterial.Builder> keyMaterial)

      The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.

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

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

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

    • keyCheckValueAlgorithm

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

      ImportKeyRequest.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:

    • enabled

      ImportKeyRequest.Builder enabled(Boolean enabled)

      Specifies whether import key is enabled.

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

    • tags

      ImportKeyRequest.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 imported. 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. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.

      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 imported. 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. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.

      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

      ImportKeyRequest.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 imported. 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. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.

      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 imported. 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. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.

      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

      ImportKeyRequest.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 imported. 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. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.

      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<Tag>).

      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:

    • overrideConfiguration

      ImportKeyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ImportKeyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.