software.amazon.awssdk.services.securityhub.model

Interface AwsKmsKeyDetails.Builder

All Superinterfaces:

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

Enclosing class:

AwsKmsKeyDetails

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

Method Summary

Modifier and Type	Method and Description
AwsKmsKeyDetails.Builder	awsAccountId(String awsAccountId) The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
AwsKmsKeyDetails.Builder	creationDate(Double creationDate) Indicates when the KMS key was created.
AwsKmsKeyDetails.Builder	description(String description) A description of the KMS key.
AwsKmsKeyDetails.Builder	keyId(String keyId) The globally unique identifier for the KMS key.
AwsKmsKeyDetails.Builder	keyManager(String keyManager) The manager of the KMS key.
AwsKmsKeyDetails.Builder	keyRotationStatus(Boolean keyRotationStatus) Whether the key has key rotation enabled.
AwsKmsKeyDetails.Builder	keyState(String keyState) The state of the KMS key.
AwsKmsKeyDetails.Builder	origin(String origin) The source of the KMS key material.

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

AwsKmsKeyDetails.Builder awsAccountId(String awsAccountId)

The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

Parameters:

awsAccountId - The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

Returns:

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

creationDate

AwsKmsKeyDetails.Builder creationDate(Double creationDate)

Indicates when the KMS key was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

Parameters:

creationDate - Indicates when the KMS key was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

Returns:

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

keyId

AwsKmsKeyDetails.Builder keyId(String keyId)

The globally unique identifier for the KMS key.

Parameters:

keyId - The globally unique identifier for the KMS key.

Returns:

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

keyManager

AwsKmsKeyDetails.Builder keyManager(String keyManager)

The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

Parameters:

keyManager - The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

Returns:

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

keyState

AwsKmsKeyDetails.Builder keyState(String keyState)

The state of the KMS key. Valid values are as follows:

• Disabled

• Enabled

• PendingDeletion

• PendingImport

• Unavailable

Parameters:

keyState - The state of the KMS key. Valid values are as follows:

• Disabled

• Enabled

• PendingDeletion

• PendingImport

• Unavailable

Returns:

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

origin

AwsKmsKeyDetails.Builder origin(String origin)

The source of the KMS key material.

When this value is AWS_KMS, KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the KMS key lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

Parameters:

origin - The source of the KMS key material.

When this value is AWS_KMS, KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the KMS key lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

Returns:

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

description

AwsKmsKeyDetails.Builder description(String description)

A description of the KMS key.

Parameters:

description - A description of the KMS key.

Returns:

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

keyRotationStatus

AwsKmsKeyDetails.Builder keyRotationStatus(Boolean keyRotationStatus)

Whether the key has key rotation enabled.

Parameters:

keyRotationStatus - Whether the key has key rotation enabled.

Returns:

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