Class KmsEncryptionConfig

java.lang.Object
software.amazon.awssdk.services.healthlake.model.KmsEncryptionConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<KmsEncryptionConfig.Builder,KmsEncryptionConfig>
@Generated("software.amazon.awssdk:codegen") public final class KmsEncryptionConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<KmsEncryptionConfig.Builder,KmsEncryptionConfig>

The customer-managed-key(CMK) used when creating a data store. If a customer owned key is not specified, an AWS owned key will be used for encryption.

See Also:

  • Method Details

    • cmkType

      public final CmkType cmkType()

      The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.

      If the service returns an enum value that is not available in the current SDK version, cmkType will return CmkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cmkTypeAsString().

      Returns:
      The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
      See Also:

    • cmkTypeAsString

      public final String cmkTypeAsString()

      The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.

      If the service returns an enum value that is not available in the current SDK version, cmkType will return CmkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cmkTypeAsString().

      Returns:
      The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
      See Also:

    • kmsKeyId

      public final String kmsKeyId()

      The KMS encryption key id/alias used to encrypt the data store contents at rest.

      Returns:
      The KMS encryption key id/alias used to encrypt the data store contents at rest.

    • toBuilder

      public KmsEncryptionConfig.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<KmsEncryptionConfig.Builder,KmsEncryptionConfig>
      Returns:
      a builder for type T

    • builder

      public static KmsEncryptionConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends KmsEncryptionConfig.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.