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

All Methods Static Methods Instance Methods Concrete Methods
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.
`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.
    
    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
```
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

Class AwsKmsKeyDetails

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

awsAccountId

creationDate

keyId

keyManager

keyState

origin

description

keyRotationStatus

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields