Class AwsOpenSearchServiceDomainClusterConfigDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsOpenSearchServiceDomainClusterConfigDetails.Builder,
AwsOpenSearchServiceDomainClusterConfigDetails>
Details about the configuration of an OpenSearch cluster.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Integer
The number of instances to use for the master node.final Boolean
Whether to use a dedicated master node for the OpenSearch domain.final String
The hardware configuration of the computer that hosts the dedicated master node.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
The number of data nodes to use in the OpenSearch domain.final String
The instance type for your data nodes.static Class
<? extends AwsOpenSearchServiceDomainClusterConfigDetails.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
The number of UltraWarm instances.final Boolean
Whether UltraWarm is enabled.final String
warmType()
The type of UltraWarm instance.Configuration options for zone awareness.final Boolean
Whether to enable zone awareness for the OpenSearch domain.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Whether UltraWarm is enabled.
- Returns:
- Whether UltraWarm is enabled.
-
warmCount
The number of UltraWarm instances.
- Returns:
- The number of UltraWarm instances.
-
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
istrue
.- Returns:
- Configuration options for zone awareness. Provided if
ZoneAwarenessEnabled
istrue
.
-
dedicatedMasterCount
The number of instances to use for the master node. If this attribute is specified, then
DedicatedMasterEnabled
must betrue
.- Returns:
- The number of instances to use for the master node. If this attribute is specified, then
DedicatedMasterEnabled
must betrue
.
-
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
The type of UltraWarm instance.
- Returns:
- The type of UltraWarm instance.
-
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
The hardware configuration of the computer that hosts the dedicated master node.
If this attribute is specified, then
DedicatedMasterEnabled
must betrue
.- Returns:
- The hardware configuration of the computer that hosts the dedicated master node.
If this attribute is specified, then
DedicatedMasterEnabled
must betrue
.
-
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 interfaceToCopyableBuilder<AwsOpenSearchServiceDomainClusterConfigDetails.Builder,
AwsOpenSearchServiceDomainClusterConfigDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends AwsOpenSearchServiceDomainClusterConfigDetails.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-