Class AwsOpenSearchServiceDomainClusterConfigDetails

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

Details about the configuration of an OpenSearch cluster.

See Also:

  • Method Details

    • instanceCount

      public final Integer instanceCount()

      The number of data nodes to use in the OpenSearch domain.

      Returns:
      The number of data nodes to use in the OpenSearch domain.

    • warmEnabled

      public final Boolean warmEnabled()

      Whether UltraWarm is enabled.

      Returns:
      Whether UltraWarm is enabled.

    • warmCount

      public final Integer warmCount()

      The number of UltraWarm instances.

      Returns:
      The number of UltraWarm instances.

    • dedicatedMasterEnabled

      public final Boolean dedicatedMasterEnabled()

      Whether to use a dedicated master node for the OpenSearch domain. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.

      Returns:
      Whether to use a dedicated master node for the OpenSearch domain. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.

    • zoneAwarenessConfig

      public final AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails zoneAwarenessConfig()

      Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.

      Returns:
      Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.

    • dedicatedMasterCount

      public final Integer dedicatedMasterCount()

      The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.

      Returns:
      The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.

    • instanceType

      public final String instanceType()

      The instance type for your data nodes.

      For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

      Returns:
      The instance type for your data nodes.

      For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

    • warmType

      public final String warmType()

      The type of UltraWarm instance.

      Returns:
      The type of UltraWarm instance.

    • zoneAwarenessEnabled

      public final Boolean zoneAwarenessEnabled()

      Whether to enable zone awareness for the OpenSearch domain. When zone awareness is enabled, OpenSearch Service allocates the cluster's nodes and replica index shards across Availability Zones (AZs) in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.

      Returns:
      Whether to enable zone awareness for the OpenSearch domain. When zone awareness is enabled, OpenSearch Service allocates the cluster's nodes and replica index shards across Availability Zones (AZs) in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.

    • dedicatedMasterType

      public final String dedicatedMasterType()

      The hardware configuration of the computer that hosts the dedicated master node.

      If this attribute is specified, then DedicatedMasterEnabled must be true.

      Returns:
      The hardware configuration of the computer that hosts the dedicated master node.

      If this attribute is specified, then DedicatedMasterEnabled must be true.

    • toBuilder

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

    • builder

      public static AwsOpenSearchServiceDomainClusterConfigDetails.Builder builder()

    • serializableBuilderClass

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