Interface KeySummary.Builder

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

  • Method Details

    • keyArn

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

    • keyState

      KeySummary.Builder keyState(String keyState)

      The state of an Amazon Web Services Payment Cryptography that is being created or deleted.

      Parameters:
      keyState - The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • keyState

      KeySummary.Builder keyState(KeyState keyState)

      The state of an Amazon Web Services Payment Cryptography that is being created or deleted.

      Parameters:
      keyState - The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • keyAttributes

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

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

    • exportable

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

    • enabled

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

    • multiRegionKeyType

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

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

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