software.amazon.awssdk.services.kms.model

Interface KeyMetadata.Builder

All Superinterfaces:

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

Enclosing class:

KeyMetadata

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

Method Summary

Modifier and Type	Method and Description
KeyMetadata.Builder	arn(String arn) The Amazon Resource Name (ARN) of the CMK.
KeyMetadata.Builder	awsAccountId(String awsAccountId) The twelve-digit account ID of the AWS account that owns the CMK.
KeyMetadata.Builder	cloudHsmClusterId(String cloudHsmClusterId) The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK.
KeyMetadata.Builder	creationDate(Instant creationDate) The date and time when the CMK was created.
KeyMetadata.Builder	customerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec) Describes the type of key material in the CMK.
KeyMetadata.Builder	customerMasterKeySpec(String customerMasterKeySpec) Describes the type of key material in the CMK.
KeyMetadata.Builder	customKeyStoreId(String customKeyStoreId) A unique identifier for the custom key store that contains the CMK.
KeyMetadata.Builder	deletionDate(Instant deletionDate) The date and time after which AWS KMS deletes the CMK.
KeyMetadata.Builder	description(String description) The description of the CMK.
KeyMetadata.Builder	enabled(Boolean enabled) Specifies whether the CMK is enabled.
KeyMetadata.Builder	encryptionAlgorithms(Collection<EncryptionAlgorithmSpec> encryptionAlgorithms) A list of encryption algorithms that the CMK supports.
KeyMetadata.Builder	encryptionAlgorithms(EncryptionAlgorithmSpec... encryptionAlgorithms) A list of encryption algorithms that the CMK supports.
KeyMetadata.Builder	encryptionAlgorithmsWithStrings(Collection<String> encryptionAlgorithms) A list of encryption algorithms that the CMK supports.
KeyMetadata.Builder	encryptionAlgorithmsWithStrings(String... encryptionAlgorithms) A list of encryption algorithms that the CMK supports.
KeyMetadata.Builder	expirationModel(ExpirationModelType expirationModel) Specifies whether the CMK's key material expires.
KeyMetadata.Builder	expirationModel(String expirationModel) Specifies whether the CMK's key material expires.
KeyMetadata.Builder	keyId(String keyId) The globally unique identifier for the CMK.
KeyMetadata.Builder	keyManager(KeyManagerType keyManager) The manager of the CMK.
KeyMetadata.Builder	keyManager(String keyManager) The manager of the CMK.
KeyMetadata.Builder	keyState(KeyState keyState) The state of the CMK.
KeyMetadata.Builder	keyState(String keyState) The state of the CMK.
KeyMetadata.Builder	keyUsage(KeyUsageType keyUsage) The cryptographic operations for which you can use the CMK.
KeyMetadata.Builder	keyUsage(String keyUsage) The cryptographic operations for which you can use the CMK.
KeyMetadata.Builder	origin(OriginType origin) The source of the CMK's key material.
KeyMetadata.Builder	origin(String origin) The source of the CMK's key material.
KeyMetadata.Builder	signingAlgorithms(Collection<SigningAlgorithmSpec> signingAlgorithms) A list of signing algorithms that the CMK supports.
KeyMetadata.Builder	signingAlgorithms(SigningAlgorithmSpec... signingAlgorithms) A list of signing algorithms that the CMK supports.
KeyMetadata.Builder	signingAlgorithmsWithStrings(Collection<String> signingAlgorithms) A list of signing algorithms that the CMK supports.
KeyMetadata.Builder	signingAlgorithmsWithStrings(String... signingAlgorithms) A list of signing algorithms that the CMK supports.
KeyMetadata.Builder	validTo(Instant validTo) The time at which the imported key material expires.

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

awsAccountId

KeyMetadata.Builder awsAccountId(String awsAccountId)

The twelve-digit account ID of the AWS account that owns the CMK.

Parameters:

awsAccountId - The twelve-digit account ID of the AWS account that owns the CMK.

Returns:

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

keyId

KeyMetadata.Builder keyId(String keyId)

The globally unique identifier for the CMK.

Parameters:

keyId - The globally unique identifier for the CMK.

Returns:

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

arn

KeyMetadata.Builder arn(String arn)

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

Parameters:

arn - The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

Returns:

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

creationDate

KeyMetadata.Builder creationDate(Instant creationDate)

The date and time when the CMK was created.

Parameters:

creationDate - The date and time when the CMK was created.

Returns:

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

enabled

KeyMetadata.Builder enabled(Boolean enabled)

Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.

Parameters:

enabled - Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.

Returns:

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

description

KeyMetadata.Builder description(String description)

The description of the CMK.

Parameters:

description - The description of the CMK.

Returns:

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

keyUsage

KeyMetadata.Builder keyUsage(String keyUsage)

The cryptographic operations for which you can use the CMK.

Parameters:

keyUsage - The cryptographic operations for which you can use the CMK.

Returns:

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

See Also:

KeyUsageType, KeyUsageType

keyUsage

KeyMetadata.Builder keyUsage(KeyUsageType keyUsage)

The cryptographic operations for which you can use the CMK.

Parameters:

keyUsage - The cryptographic operations for which you can use the CMK.

Returns:

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

See Also:

KeyUsageType, KeyUsageType

keyState

KeyMetadata.Builder keyState(String keyState)

The state of the CMK.

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameters:

keyState - The state of the CMK.

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Returns:

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

See Also:

KeyState, KeyState

keyState

KeyMetadata.Builder keyState(KeyState keyState)

The state of the CMK.

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameters:

keyState - The state of the CMK.

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Returns:

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

See Also:

KeyState, KeyState

deletionDate

KeyMetadata.Builder deletionDate(Instant deletionDate)

The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.

Parameters:

deletionDate - The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.

Returns:

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

validTo

KeyMetadata.Builder validTo(Instant validTo)

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

Parameters:

validTo - The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

Returns:

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

origin

KeyMetadata.Builder origin(String origin)

The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.

Parameters:

origin - The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.

Returns:

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

See Also:

OriginType, OriginType

origin

KeyMetadata.Builder origin(OriginType origin)

The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.

Parameters:

origin - The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.

Returns:

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

See Also:

OriginType, OriginType

customKeyStoreId

KeyMetadata.Builder customKeyStoreId(String customKeyStoreId)

A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.

Parameters:

customKeyStoreId - A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.

Returns:

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

cloudHsmClusterId

KeyMetadata.Builder cloudHsmClusterId(String cloudHsmClusterId)

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.

Parameters:

cloudHsmClusterId - The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.

Returns:

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

expirationModel

KeyMetadata.Builder expirationModel(String expirationModel)

Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

Parameters:

expirationModel - Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

Returns:

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

See Also:

ExpirationModelType, ExpirationModelType

expirationModel

KeyMetadata.Builder expirationModel(ExpirationModelType expirationModel)

Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

Parameters:

expirationModel - Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

Returns:

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

See Also:

ExpirationModelType, ExpirationModelType

keyManager

KeyMetadata.Builder keyManager(String keyManager)

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.

Parameters:

keyManager - The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.

Returns:

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

See Also:

KeyManagerType, KeyManagerType

keyManager

KeyMetadata.Builder keyManager(KeyManagerType keyManager)

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.

Parameters:

keyManager - The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.

Returns:

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

See Also:

KeyManagerType, KeyManagerType

customerMasterKeySpec

KeyMetadata.Builder customerMasterKeySpec(String customerMasterKeySpec)

Describes the type of key material in the CMK.

Parameters:

customerMasterKeySpec - Describes the type of key material in the CMK.

Returns:

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

See Also:

CustomerMasterKeySpec, CustomerMasterKeySpec

customerMasterKeySpec

KeyMetadata.Builder customerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)

Describes the type of key material in the CMK.

Parameters:

customerMasterKeySpec - Describes the type of key material in the CMK.

Returns:

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

See Also:

CustomerMasterKeySpec, CustomerMasterKeySpec

encryptionAlgorithmsWithStrings

KeyMetadata.Builder encryptionAlgorithmsWithStrings(Collection<String> encryptionAlgorithms)

A list of encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Parameters:

encryptionAlgorithms - A list of encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Returns:

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

encryptionAlgorithmsWithStrings

KeyMetadata.Builder encryptionAlgorithmsWithStrings(String... encryptionAlgorithms)

A list of encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Parameters:

encryptionAlgorithms - A list of encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Returns:

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

encryptionAlgorithms

KeyMetadata.Builder encryptionAlgorithms(Collection<EncryptionAlgorithmSpec> encryptionAlgorithms)

A list of encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Parameters:

encryptionAlgorithms - A list of encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Returns:

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

encryptionAlgorithms

KeyMetadata.Builder encryptionAlgorithms(EncryptionAlgorithmSpec... encryptionAlgorithms)

A list of encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Parameters:

encryptionAlgorithms - A list of encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Returns:

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

signingAlgorithmsWithStrings

KeyMetadata.Builder signingAlgorithmsWithStrings(Collection<String> signingAlgorithms)

A list of signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Parameters:

signingAlgorithms - A list of signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Returns:

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

signingAlgorithmsWithStrings

KeyMetadata.Builder signingAlgorithmsWithStrings(String... signingAlgorithms)

A list of signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Parameters:

signingAlgorithms - A list of signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Returns:

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

signingAlgorithms

KeyMetadata.Builder signingAlgorithms(Collection<SigningAlgorithmSpec> signingAlgorithms)

A list of signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Parameters:

signingAlgorithms - A list of signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Returns:

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

signingAlgorithms

KeyMetadata.Builder signingAlgorithms(SigningAlgorithmSpec... signingAlgorithms)

A list of signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Parameters:

signingAlgorithms - A list of signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Returns:

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