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

Interface ClusterConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ClusterConfig.Builder,ClusterConfig>, SdkBuilder<ClusterConfig.Builder,ClusterConfig>, SdkPojo

Enclosing class:

ClusterConfig

public static interface ClusterConfig.Builder
extends SdkPojo, CopyableBuilder<ClusterConfig.Builder,ClusterConfig>

Method Summary

Modifier and Type	Method	Description
default ClusterConfig.Builder	coldStorageOptions(Consumer<ColdStorageOptions.Builder> coldStorageOptions)	Container for cold storage configuration options.
ClusterConfig.Builder	coldStorageOptions(ColdStorageOptions coldStorageOptions)	Container for cold storage configuration options.
ClusterConfig.Builder	dedicatedMasterCount(Integer dedicatedMasterCount)	Number of dedicated master nodes in the cluster.
ClusterConfig.Builder	dedicatedMasterEnabled(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.
ClusterConfig.Builder	dedicatedMasterType(String dedicatedMasterType)	OpenSearch Service instance type of the dedicated master nodes in the cluster.
ClusterConfig.Builder	dedicatedMasterType(OpenSearchPartitionInstanceType dedicatedMasterType)	OpenSearch Service instance type of the dedicated master nodes in the cluster.
ClusterConfig.Builder	instanceCount(Integer instanceCount)	Number of data nodes in the cluster.
ClusterConfig.Builder	instanceType(String instanceType)	Instance type of data nodes in the cluster.
ClusterConfig.Builder	instanceType(OpenSearchPartitionInstanceType instanceType)	Instance type of data nodes in the cluster.
ClusterConfig.Builder	multiAZWithStandbyEnabled(Boolean multiAZWithStandbyEnabled)	A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ.
ClusterConfig.Builder	warmCount(Integer warmCount)	The number of warm nodes in the cluster.
ClusterConfig.Builder	warmEnabled(Boolean warmEnabled)	Whether to enable warm storage for the cluster.
ClusterConfig.Builder	warmType(String warmType)	The instance type for the cluster's warm nodes.
ClusterConfig.Builder	warmType(OpenSearchWarmPartitionInstanceType warmType)	The instance type for the cluster's warm nodes.
default ClusterConfig.Builder	zoneAwarenessConfig(Consumer<ZoneAwarenessConfig.Builder> zoneAwarenessConfig)	Container for zone awareness configuration options.
ClusterConfig.Builder	zoneAwarenessConfig(ZoneAwarenessConfig zoneAwarenessConfig)	Container for zone awareness configuration options.
ClusterConfig.Builder	zoneAwarenessEnabled(Boolean zoneAwarenessEnabled)	Indicates whether multiple Availability Zones are enabled.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

instanceType

ClusterConfig.Builder instanceType(String instanceType)

Instance type of data nodes in the cluster.

Parameters:

instanceType - Instance type of data nodes in the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• OpenSearchPartitionInstanceType
• OpenSearchPartitionInstanceType

instanceType

ClusterConfig.Builder instanceType(OpenSearchPartitionInstanceType instanceType)

Instance type of data nodes in the cluster.

Parameters:

instanceType - Instance type of data nodes in the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• OpenSearchPartitionInstanceType
• OpenSearchPartitionInstanceType

instanceCount

ClusterConfig.Builder instanceCount(Integer instanceCount)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dedicatedMasterEnabled

ClusterConfig.Builder dedicatedMasterEnabled(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

zoneAwarenessEnabled

ClusterConfig.Builder zoneAwarenessEnabled(Boolean zoneAwarenessEnabled)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

zoneAwarenessConfig

ClusterConfig.Builder zoneAwarenessConfig(ZoneAwarenessConfig zoneAwarenessConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

zoneAwarenessConfig

default ClusterConfig.Builder zoneAwarenessConfig(Consumer<ZoneAwarenessConfig.Builder> zoneAwarenessConfig)

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

This is a convenience method that creates an instance of the ZoneAwarenessConfig.Builder avoiding the need to create one manually via ZoneAwarenessConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to zoneAwarenessConfig(ZoneAwarenessConfig).

Parameters:

zoneAwarenessConfig - a consumer that will call methods on ZoneAwarenessConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• zoneAwarenessConfig(ZoneAwarenessConfig)

dedicatedMasterType

ClusterConfig.Builder dedicatedMasterType(String dedicatedMasterType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• OpenSearchPartitionInstanceType
• OpenSearchPartitionInstanceType

dedicatedMasterType

ClusterConfig.Builder dedicatedMasterType(OpenSearchPartitionInstanceType dedicatedMasterType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• OpenSearchPartitionInstanceType
• OpenSearchPartitionInstanceType

dedicatedMasterCount

ClusterConfig.Builder dedicatedMasterCount(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

warmEnabled

ClusterConfig.Builder warmEnabled(Boolean warmEnabled)

Whether to enable warm storage for the cluster.

Parameters:

warmEnabled - Whether to enable warm storage for the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

warmType

ClusterConfig.Builder warmType(String warmType)

The instance type for the cluster's warm nodes.

Parameters:

warmType - The instance type for the cluster's warm nodes.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• OpenSearchWarmPartitionInstanceType
• OpenSearchWarmPartitionInstanceType

warmType

ClusterConfig.Builder warmType(OpenSearchWarmPartitionInstanceType warmType)

The instance type for the cluster's warm nodes.

Parameters:

warmType - The instance type for the cluster's warm nodes.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• OpenSearchWarmPartitionInstanceType
• OpenSearchWarmPartitionInstanceType

warmCount

ClusterConfig.Builder warmCount(Integer warmCount)

The number of warm nodes in the cluster.

Parameters:

warmCount - The number of warm nodes in the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

coldStorageOptions

ClusterConfig.Builder coldStorageOptions(ColdStorageOptions coldStorageOptions)

Container for cold storage configuration options.

Parameters:

coldStorageOptions - Container for cold storage configuration options.

Returns:

Returns a reference to this object so that method calls can be chained together.

coldStorageOptions

default ClusterConfig.Builder coldStorageOptions(Consumer<ColdStorageOptions.Builder> coldStorageOptions)

Container for cold storage configuration options.

This is a convenience method that creates an instance of the ColdStorageOptions.Builder avoiding the need to create one manually via ColdStorageOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to coldStorageOptions(ColdStorageOptions).

Parameters:

coldStorageOptions - a consumer that will call methods on ColdStorageOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• coldStorageOptions(ColdStorageOptions)

multiAZWithStandbyEnabled

ClusterConfig.Builder multiAZWithStandbyEnabled(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.