software.amazon.awssdk.services.paymentcryptography.model

Interface KeySummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<KeySummary.Builder,KeySummary>, SdkBuilder<KeySummary.Builder,KeySummary>, SdkPojo

Enclosing class:

KeySummary

public static interface KeySummary.Builder
extends SdkPojo, CopyableBuilder<KeySummary.Builder,KeySummary>

Method Summary

Modifier and Type	Method and Description
KeySummary.Builder	enabled(Boolean enabled) Specifies whether the key is enabled.
KeySummary.Builder	exportable(Boolean exportable) Specifies whether the key is exportable.
KeySummary.Builder	keyArn(String keyArn) The Amazon Resource Name (ARN) of the key.
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.
KeySummary.Builder	keyAttributes(KeyAttributes keyAttributes) The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.
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.
KeySummary.Builder	keyState(KeyState keyState) The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
KeySummary.Builder	keyState(String keyState) The state of an Amazon Web Services Payment Cryptography that is being created or deleted.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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.

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.

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.

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:

keyAttributes(KeyAttributes)

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. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

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. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

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, KeyState

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:

KeyState, KeyState