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(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ElasticsearchClusterConfig.Builder

Method Summary

Modifier and Type	Method and Description
static ElasticsearchClusterConfig.Builder	builder()
ColdStorageOptions	coldStorageOptions() Specifies the ColdStorageOptions configuration for an Elasticsearch domain.
Integer	dedicatedMasterCount() Total number of dedicated master nodes, active and on standby, for the cluster.
Boolean	dedicatedMasterEnabled() A boolean value to indicate whether a dedicated master node is enabled.
ESPartitionInstanceType	dedicatedMasterType() The instance type for a dedicated master node.
String	dedicatedMasterTypeAsString() The instance type for a dedicated master node.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	instanceCount() The number of instances in the specified domain cluster.
ESPartitionInstanceType	instanceType() The instance type for an Elasticsearch cluster.
String	instanceTypeAsString() The instance type for an Elasticsearch cluster.
List<SdkField<?>>	sdkFields()
static Class<? extends ElasticsearchClusterConfig.Builder>	serializableBuilderClass()
ElasticsearchClusterConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	warmCount() The number of warm nodes in the cluster.
Boolean	warmEnabled() True to enable warm storage.
ESWarmPartitionInstanceType	warmType() The instance type for the Elasticsearch cluster's warm nodes.
String	warmTypeAsString() The instance type for the Elasticsearch cluster's warm nodes.
ZoneAwarenessConfig	zoneAwarenessConfig() Specifies the zone awareness configuration for a domain when zone awareness is enabled.
Boolean	zoneAwarenessEnabled() A boolean value to indicate whether zone awareness is 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 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:

ESPartitionInstanceType

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:

ESPartitionInstanceType

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:

ESPartitionInstanceType

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:

ESPartitionInstanceType

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:

ESWarmPartitionInstanceType

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:

ESWarmPartitionInstanceType

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 configuration for an Elasticsearch domain.

Returns:

Specifies the ColdStorageOptions configuration for an Elasticsearch domain.

toBuilder

public ElasticsearchClusterConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ElasticsearchClusterConfig.Builder,ElasticsearchClusterConfig>

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)

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