Interface Key.Builder

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

  • Method Details

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

    • keyAttributes

      default Key.Builder keyAttributes(Consumer<KeyAttributes.Builder> 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.

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

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

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

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

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keyCheckValueAlgorithm

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

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

      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.

    • 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

      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:

    • 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

      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:

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

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

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

    • deriveKeyUsage

      Key.Builder deriveKeyUsage(String deriveKeyUsage)

      The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec.

      Parameters:
      deriveKeyUsage - The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deriveKeyUsage

      Key.Builder deriveKeyUsage(DeriveKeyUsage deriveKeyUsage)

      The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec.

      Parameters:
      deriveKeyUsage - The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • multiRegionKeyType

      Key.Builder multiRegionKeyType(String multiRegionKeyType)

      Indicates whether this key is a multi-region key and its role in the multi-region key hierarchy.

      Multi-region keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a primary key (which can be replicated to other regions) or a replica key (which is a copy of a primary key in another region).

      Parameters:
      multiRegionKeyType - Indicates whether this key is a multi-region key and its role in the multi-region key hierarchy.

      Multi-region keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a primary key (which can be replicated to other regions) or a replica key (which is a copy of a primary key in another region).

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

    • multiRegionKeyType

      Key.Builder multiRegionKeyType(MultiRegionKeyType multiRegionKeyType)

      Indicates whether this key is a multi-region key and its role in the multi-region key hierarchy.

      Multi-region keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a primary key (which can be replicated to other regions) or a replica key (which is a copy of a primary key in another region).

      Parameters:
      multiRegionKeyType - Indicates whether this key is a multi-region key and its role in the multi-region key hierarchy.

      Multi-region keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a primary key (which can be replicated to other regions) or a replica key (which is a copy of a primary key in another region).

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

    • primaryRegion

      Key.Builder primaryRegion(String primaryRegion)
      Sets the value of the PrimaryRegion property for this object.
      Parameters:
      primaryRegion - The new value for the PrimaryRegion property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • replicationStatus

      Key.Builder replicationStatus(Map<String,ReplicationStatusType> replicationStatus)

      Information about the replication status of the key across different regions.

      This field provides details about the current state of key replication, including any status messages or operational information. It helps track the progress and health of key replication operations.

      Parameters:
      replicationStatus - Information about the replication status of the key across different regions.

      This field provides details about the current state of key replication, including any status messages or operational information. It helps track the progress and health of key replication operations.

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

    • usingDefaultReplicationRegions

      Key.Builder usingDefaultReplicationRegions(Boolean usingDefaultReplicationRegions)

      Indicates whether this key is using the account's default replication regions configuration.

      When set to true, the key automatically replicates to the regions specified in the account's default replication settings. When set to false, the key has a custom replication configuration that overrides the account defaults.

      Parameters:
      usingDefaultReplicationRegions - Indicates whether this key is using the account's default replication regions configuration.

      When set to true, the key automatically replicates to the regions specified in the account's default replication settings. When set to false, the key has a custom replication configuration that overrides the account defaults.

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