Package software.amazon.awssdk.services.elasticsearch.model

Class ElasticsearchClusterConfig

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

Specifies the configuration for the domain cluster, such as the type and number of instances.

See Also:

  • Method Details

    • instanceType

      public final ESPartitionInstanceType instanceType()

      The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.

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

      Returns:
      The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.

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

      Returns:
      The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
      See Also:

    • instanceCount

      public final Integer instanceCount()

      The number of instances in the specified domain cluster.

      Returns:
      The number of instances in the specified domain cluster.

    • dedicatedMasterEnabled

      public final Boolean dedicatedMasterEnabled()

      A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

      Returns:
      A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

    • zoneAwarenessEnabled

      public final Boolean zoneAwarenessEnabled()

      A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

      Returns:
      A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

    • zoneAwarenessConfig

      public final ZoneAwarenessConfig zoneAwarenessConfig()

      Specifies the zone awareness configuration for a domain when zone awareness is enabled.

      Returns:
      Specifies the zone awareness configuration for a domain when zone awareness is enabled.

    • dedicatedMasterType

      public final ESPartitionInstanceType dedicatedMasterType()

      The instance type for a dedicated master node.

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

      Returns:
      The instance type for a dedicated master node.
      See Also:

    • dedicatedMasterTypeAsString

      public final String dedicatedMasterTypeAsString()

      The instance type for a dedicated master node.

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

      Returns:
      The instance type for a dedicated master node.
      See Also:

    • dedicatedMasterCount

      public final Integer dedicatedMasterCount()

      Total number of dedicated master nodes, active and on standby, for the cluster.

      Returns:
      Total number of dedicated master nodes, active and on standby, for the cluster.

    • warmEnabled

      public final Boolean warmEnabled()

      True to enable warm storage.

      Returns:
      True to enable warm storage.

    • warmType

      public final ESWarmPartitionInstanceType warmType()

      The instance type for the Elasticsearch cluster's warm nodes.

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

      Returns:
      The instance type for the Elasticsearch cluster's warm nodes.
      See Also:

    • warmTypeAsString

      public final String warmTypeAsString()

      The instance type for the Elasticsearch cluster's warm nodes.

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

      Returns:
      The instance type for the Elasticsearch cluster's warm nodes.
      See Also:

    • warmCount

      public final Integer warmCount()

      The number of warm nodes in the cluster.

      Returns:
      The number of warm nodes in the cluster.

    • coldStorageOptions

      public final ColdStorageOptions coldStorageOptions()

      Specifies the ColdStorageOptions config for Elasticsearch Domain

      Returns:
      Specifies the ColdStorageOptions config for Elasticsearch Domain

    • toBuilder

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

    • builder

      public static ElasticsearchClusterConfig.Builder builder()

    • serializableBuilderClass

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