Class EncryptionAtRestOptions

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

Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at rest for the first time on an existing domain. You can't modify this parameter after it's already been specified.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      True to enable encryption at rest.

      Returns:
      True to enable encryption at rest.

    • kmsKeyId

      public final String kmsKeyId()

      The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

      Returns:
      The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

    • encryptionMode

      public final EncryptionMode encryptionMode()

      The type of encryption at rest applied to the domain's data. Valid values are DISK and NATIVE. DISK is the default and uses volume-level encryption. NATIVE uses engine-native, index-level encryption and requires encryption at rest to be enabled and OpenSearch version 3.3 or later. After the mode is set to NATIVE, it can't be changed back to DISK.

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

      Returns:
      The type of encryption at rest applied to the domain's data. Valid values are DISK and NATIVE. DISK is the default and uses volume-level encryption. NATIVE uses engine-native, index-level encryption and requires encryption at rest to be enabled and OpenSearch version 3.3 or later. After the mode is set to NATIVE, it can't be changed back to DISK.
      See Also:

    • encryptionModeAsString

      public final String encryptionModeAsString()

      The type of encryption at rest applied to the domain's data. Valid values are DISK and NATIVE. DISK is the default and uses volume-level encryption. NATIVE uses engine-native, index-level encryption and requires encryption at rest to be enabled and OpenSearch version 3.3 or later. After the mode is set to NATIVE, it can't be changed back to DISK.

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

      Returns:
      The type of encryption at rest applied to the domain's data. Valid values are DISK and NATIVE. DISK is the default and uses volume-level encryption. NATIVE uses engine-native, index-level encryption and requires encryption at rest to be enabled and OpenSearch version 3.3 or later. After the mode is set to NATIVE, it can't be changed back to DISK.
      See Also:

    • toBuilder

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

    • builder

      public static EncryptionAtRestOptions.Builder builder()

    • serializableBuilderClass

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