Package software.amazon.awssdk.services.opensearch.model

Class ClusterConfig

java.lang.Object

software.amazon.awssdk.services.opensearch.model.ClusterConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ClusterConfig.Builder,ClusterConfig>

@Generated("software.amazon.awssdk:codegen")
public final class ClusterConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ClusterConfig.Builder,ClusterConfig>

Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClusterConfig.Builder

Method Summary

Modifier and Type	Method	Description
static ClusterConfig.Builder	builder()
ColdStorageOptions	coldStorageOptions()	Container for cold storage configuration options.
Integer	dedicatedMasterCount()	Number of dedicated master nodes in the cluster.
Boolean	dedicatedMasterEnabled()	Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.
OpenSearchPartitionInstanceType	dedicatedMasterType()	OpenSearch Service instance type of the dedicated master nodes in the cluster.
String	dedicatedMasterTypeAsString()	OpenSearch Service instance type of the dedicated master nodes in the cluster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	instanceCount()	Number of data nodes in the cluster.
OpenSearchPartitionInstanceType	instanceType()	Instance type of data nodes in the cluster.
String	instanceTypeAsString()	Instance type of data nodes in the cluster.
Boolean	multiAZWithStandbyEnabled()	A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ.
List<SdkField<?>>	sdkFields()
static Class<? extends ClusterConfig.Builder>	serializableBuilderClass()
ClusterConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	warmCount()	The number of warm nodes in the cluster.
Boolean	warmEnabled()	Whether to enable warm storage for the cluster.
OpenSearchWarmPartitionInstanceType	warmType()	The instance type for the cluster's warm nodes.
String	warmTypeAsString()	The instance type for the cluster's warm nodes.
ZoneAwarenessConfig	zoneAwarenessConfig()	Container for zone awareness configuration options.
Boolean	zoneAwarenessEnabled()	Indicates whether multiple Availability Zones are enabled.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

instanceType

public final OpenSearchPartitionInstanceType instanceType()

Instance type of data nodes in the cluster.

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

Returns:

Instance type of data nodes in the cluster.

See Also:

OpenSearchPartitionInstanceType

instanceTypeAsString

public final String instanceTypeAsString()

Instance type of data nodes in the cluster.

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

Returns:

Instance type of data nodes in the cluster.

See Also:

OpenSearchPartitionInstanceType

instanceCount

public final Integer instanceCount()

Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

Returns:

Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

dedicatedMasterEnabled

public final Boolean dedicatedMasterEnabled()

Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

Returns:

Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

zoneAwarenessEnabled

public final Boolean zoneAwarenessEnabled()

Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

Returns:

Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

zoneAwarenessConfig

public final ZoneAwarenessConfig zoneAwarenessConfig()

Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

Returns:

Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

dedicatedMasterType

public final OpenSearchPartitionInstanceType dedicatedMasterType()

OpenSearch Service instance type of the dedicated master nodes in the cluster.

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

Returns:

OpenSearch Service instance type of the dedicated master nodes in the cluster.

See Also:

OpenSearchPartitionInstanceType

dedicatedMasterTypeAsString

public final String dedicatedMasterTypeAsString()

OpenSearch Service instance type of the dedicated master nodes in the cluster.

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

Returns:

OpenSearch Service instance type of the dedicated master nodes in the cluster.

See Also:

OpenSearchPartitionInstanceType

dedicatedMasterCount

public final Integer dedicatedMasterCount()

Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.

Returns:

Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.

warmEnabled

public final Boolean warmEnabled()

Whether to enable warm storage for the cluster.

Returns:

Whether to enable warm storage for the cluster.

warmType

public final OpenSearchWarmPartitionInstanceType warmType()

The instance type for the cluster's warm nodes.

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

Returns:

The instance type for the cluster's warm nodes.

See Also:

OpenSearchWarmPartitionInstanceType

warmTypeAsString

public final String warmTypeAsString()

The instance type for the cluster's warm nodes.

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

Returns:

The instance type for the cluster's warm nodes.

See Also:

OpenSearchWarmPartitionInstanceType

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()

Container for cold storage configuration options.

Returns:

Container for cold storage configuration options.

multiAZWithStandbyEnabled

public final Boolean multiAZWithStandbyEnabled()

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

Returns:

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

toBuilder

public ClusterConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClusterConfig.Builder,ClusterConfig>

builder

public static ClusterConfig.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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