Class AwsKmsKeyDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsKmsKeyDetails.Builder,
AwsKmsKeyDetails>
Contains metadata about an KMS key.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.static AwsKmsKeyDetails.Builder
builder()
final Double
Indicates when the KMS key was created.final String
A description of the KMS key.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
keyId()
The globally unique identifier for the KMS key.final String
The manager of the KMS key.final Boolean
Whether the key has key rotation enabled.final String
keyState()
The state of the KMS key.final String
origin()
The source of the KMS key material.static Class
<? extends AwsKmsKeyDetails.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
)
-
-
-
keyId
The globally unique identifier for the KMS key.
- Returns:
- The globally unique identifier for the KMS key.
-
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
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
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
A description of the KMS key.
- Returns:
- A description of the KMS key.
-
keyRotationStatus
Whether the key has key rotation enabled.
- Returns:
- Whether the key has key rotation enabled.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AwsKmsKeyDetails.Builder,
AwsKmsKeyDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-