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:

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<AwsKmsKeyDetails.Builder,AwsKmsKeyDetails>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.