com.amazonaws.services.securityhub.model

Class AwsKmsKeyDetails

java.lang.Object

com.amazonaws.services.securityhub.model.AwsKmsKeyDetails

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AwsKmsKeyDetails
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains metadata about an KMS key.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AwsKmsKeyDetails()

Method Summary

Modifier and Type	Method and Description
AwsKmsKeyDetails	clone()
boolean	equals(Object obj)
String	getAWSAccountId() The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
Double	getCreationDate() Indicates when the KMS key was created.
String	getDescription() A description of the KMS key.
String	getKeyId() The globally unique identifier for the KMS key.
String	getKeyManager() The manager of the KMS key.
Boolean	getKeyRotationStatus() Whether the key has key rotation enabled.
String	getKeyState() The state of the KMS key.
String	getOrigin() The source of the KMS key material.
int	hashCode()
Boolean	isKeyRotationStatus() Whether the key has key rotation enabled.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAWSAccountId(String aWSAccountId) The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
void	setCreationDate(Double creationDate) Indicates when the KMS key was created.
void	setDescription(String description) A description of the KMS key.
void	setKeyId(String keyId) The globally unique identifier for the KMS key.
void	setKeyManager(String keyManager) The manager of the KMS key.
void	setKeyRotationStatus(Boolean keyRotationStatus) Whether the key has key rotation enabled.
void	setKeyState(String keyState) The state of the KMS key.
void	setOrigin(String origin) The source of the KMS key material.
String	toString() Returns a string representation of this object.
AwsKmsKeyDetails	withAWSAccountId(String aWSAccountId) The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
AwsKmsKeyDetails	withCreationDate(Double creationDate) Indicates when the KMS key was created.
AwsKmsKeyDetails	withDescription(String description) A description of the KMS key.
AwsKmsKeyDetails	withKeyId(String keyId) The globally unique identifier for the KMS key.
AwsKmsKeyDetails	withKeyManager(String keyManager) The manager of the KMS key.
AwsKmsKeyDetails	withKeyRotationStatus(Boolean keyRotationStatus) Whether the key has key rotation enabled.
AwsKmsKeyDetails	withKeyState(String keyState) The state of the KMS key.
AwsKmsKeyDetails	withOrigin(String origin) The source of the KMS key material.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AwsKmsKeyDetails

public AwsKmsKeyDetails()

Method Detail

setAWSAccountId

public void setAWSAccountId(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.

getAWSAccountId

public String getAWSAccountId()

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.

withAWSAccountId

public AwsKmsKeyDetails withAWSAccountId(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.

setCreationDate

public void setCreationDate(Double creationDate)

Indicates when the KMS key was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Parameters:

creationDate - Indicates when the KMS key was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

getCreationDate

public Double getCreationDate()

Indicates when the KMS key was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Returns:

Indicates when the KMS key was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

withCreationDate

public AwsKmsKeyDetails withCreationDate(Double creationDate)

Indicates when the KMS key was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Parameters:

creationDate - Indicates when the KMS key was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Returns:

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

setKeyId

public void setKeyId(String keyId)

The globally unique identifier for the KMS key.

Parameters:

keyId - The globally unique identifier for the KMS key.

getKeyId

public String getKeyId()

The globally unique identifier for the KMS key.

Returns:

The globally unique identifier for the KMS key.

withKeyId

public AwsKmsKeyDetails withKeyId(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.

setKeyManager

public void setKeyManager(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.

getKeyManager

public String getKeyManager()

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.

withKeyManager

public AwsKmsKeyDetails withKeyManager(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.

setKeyState

public void setKeyState(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

getKeyState

public String getKeyState()

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

withKeyState

public AwsKmsKeyDetails withKeyState(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.

setOrigin

public void setOrigin(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.

getOrigin

public String getOrigin()

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.

withOrigin

public AwsKmsKeyDetails withOrigin(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.

setDescription

public void setDescription(String description)

A description of the KMS key.

Parameters:

description - A description of the KMS key.

getDescription

public String getDescription()

A description of the KMS key.

Returns:

A description of the KMS key.

withDescription

public AwsKmsKeyDetails withDescription(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.

setKeyRotationStatus

public void setKeyRotationStatus(Boolean keyRotationStatus)

Whether the key has key rotation enabled.

Parameters:

keyRotationStatus - Whether the key has key rotation enabled.

getKeyRotationStatus

public Boolean getKeyRotationStatus()

Whether the key has key rotation enabled.

Returns:

Whether the key has key rotation enabled.

withKeyRotationStatus

public AwsKmsKeyDetails withKeyRotationStatus(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.

isKeyRotationStatus

public Boolean isKeyRotationStatus()

Whether the key has key rotation enabled.

Returns:

Whether the key has key rotation enabled.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AwsKmsKeyDetails clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.