Enum EngineMode

java.lang.Object
java.lang.Enum<EngineMode>
software.amazon.awssdk.services.opensearch.model.EngineMode
All Implemented Interfaces:
Serializable, Comparable<EngineMode>
@Generated("software.amazon.awssdk:codegen") public enum EngineMode extends Enum<EngineMode>

The engine mode for the domain. Valid values are GENERAL (the standard OpenSearch engine) and OPTIMIZED. If you don't specify an engine mode, GENERAL is used. OPTIMIZED requires OpenSearch 3.5 or later, OpenSearch Optimized instance types (OR1, OR2, OM2, or OI2) for the data tier, and is available only for the OBSERVABILITY use cases. The engine mode can't be changed after the domain is created.

  • Enum Constant Details

    • GENERAL

      public static final EngineMode GENERAL

    • OPTIMIZED

      public static final EngineMode OPTIMIZED

    • UNKNOWN_TO_SDK_VERSION

      public static final EngineMode UNKNOWN_TO_SDK_VERSION

  • Method Details

    • values

      public static EngineMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static EngineMode valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<EngineMode>

    • fromValue

      public static EngineMode fromValue(String value)
      Use this in place of valueOf to convert the raw string returned by the service into the enum value.
      Parameters:
      value - real value
      Returns:
      EngineMode corresponding to the value

    • knownValues

      public static Set<EngineMode> knownValues()
      Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.
      Returns:
      a Set of known EngineModes