Package software.amazon.awssdk.services.securityhub.model

Class AwsKmsKeyDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsKmsKeyDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AwsKmsKeyDetails.Builder,AwsKmsKeyDetails>

@Generated("software.amazon.awssdk:codegen")
public final class AwsKmsKeyDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AwsKmsKeyDetails.Builder,AwsKmsKeyDetails>

Contains metadata about an KMS key.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AwsKmsKeyDetails.Builder

Method Summary

Modifier and Type	Method	Description
String	awsAccountId()	The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
static AwsKmsKeyDetails.Builder	builder()
Double	creationDate()	Indicates when the KMS key was created.
String	description()	A description of the KMS key.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyId()	The globally unique identifier for the KMS key.
String	keyManager()	The manager of the KMS key.
Boolean	keyRotationStatus()	Whether the key has key rotation enabled.
String	keyState()	The state of the KMS key.
String	origin()	The source of the KMS key material.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AwsKmsKeyDetails.Builder>	serializableBuilderClass()
AwsKmsKeyDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

awsAccountId

public final String awsAccountId()

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

Returns:

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

creationDate

public final Double creationDate()

Indicates when the KMS key was created.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Returns:

Indicates when the KMS key was created.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

keyId

public final String keyId()

The globally unique identifier for the KMS key.

Returns:

The globally unique identifier for the KMS key.

keyManager

public final 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.

Returns:

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

keyState

public final String keyState()

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

• Disabled

• Enabled

• PendingDeletion

• PendingImport

• Unavailable

Returns:

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

• Disabled

• Enabled

• PendingDeletion

• PendingImport

• Unavailable

origin

public final 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.

Returns:

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.

description

public final String description()

A description of the KMS key.

Returns:

A description of the KMS key.

keyRotationStatus

public final Boolean keyRotationStatus()

Whether the key has key rotation enabled.

Returns:

Whether the key has key rotation enabled.

toBuilder

public AwsKmsKeyDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsKmsKeyDetails.Builder,AwsKmsKeyDetails>

builder

public static AwsKmsKeyDetails.Builder builder()

serializableBuilderClass

public static Class<? extends AwsKmsKeyDetails.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo