Interface AwsOpenSearchServiceDomainClusterConfigDetails.Builder

All Superinterfaces:

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

Enclosing class:

AwsOpenSearchServiceDomainClusterConfigDetails

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

Method Summary

Modifier and Type	Method	Description
AwsOpenSearchServiceDomainClusterConfigDetails.Builder	dedicatedMasterCount(Integer dedicatedMasterCount)	The number of instances to use for the master node.
AwsOpenSearchServiceDomainClusterConfigDetails.Builder	dedicatedMasterEnabled(Boolean dedicatedMasterEnabled)	Whether to use a dedicated master node for the OpenSearch domain.
AwsOpenSearchServiceDomainClusterConfigDetails.Builder	dedicatedMasterType(String dedicatedMasterType)	The hardware configuration of the computer that hosts the dedicated master node.
AwsOpenSearchServiceDomainClusterConfigDetails.Builder	instanceCount(Integer instanceCount)	The number of data nodes to use in the OpenSearch domain.
AwsOpenSearchServiceDomainClusterConfigDetails.Builder	instanceType(String instanceType)	The instance type for your data nodes.
AwsOpenSearchServiceDomainClusterConfigDetails.Builder	warmCount(Integer warmCount)	The number of UltraWarm instances.
AwsOpenSearchServiceDomainClusterConfigDetails.Builder	warmEnabled(Boolean warmEnabled)	Whether UltraWarm is enabled.
AwsOpenSearchServiceDomainClusterConfigDetails.Builder	warmType(String warmType)	The type of UltraWarm instance.
default AwsOpenSearchServiceDomainClusterConfigDetails.Builder	zoneAwarenessConfig(Consumer<AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails.Builder> zoneAwarenessConfig)	Configuration options for zone awareness.
AwsOpenSearchServiceDomainClusterConfigDetails.Builder	zoneAwarenessConfig(AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails zoneAwarenessConfig)	Configuration options for zone awareness.
AwsOpenSearchServiceDomainClusterConfigDetails.Builder	zoneAwarenessEnabled(Boolean zoneAwarenessEnabled)	Whether to enable zone awareness for the OpenSearch domain.

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

instanceCount

AwsOpenSearchServiceDomainClusterConfigDetails.Builder instanceCount(Integer instanceCount)

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

Parameters:

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

Returns:

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

warmEnabled

AwsOpenSearchServiceDomainClusterConfigDetails.Builder warmEnabled(Boolean warmEnabled)

Whether UltraWarm is enabled.

Parameters:

warmEnabled - Whether UltraWarm is enabled.

Returns:

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

warmCount

AwsOpenSearchServiceDomainClusterConfigDetails.Builder warmCount(Integer warmCount)

The number of UltraWarm instances.

Parameters:

warmCount - The number of UltraWarm instances.

Returns:

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

dedicatedMasterEnabled

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

Parameters:

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:

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

zoneAwarenessConfig

AwsOpenSearchServiceDomainClusterConfigDetails.Builder zoneAwarenessConfig(AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails zoneAwarenessConfig)

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

Parameters:

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

Returns:

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

zoneAwarenessConfig

default AwsOpenSearchServiceDomainClusterConfigDetails.Builder zoneAwarenessConfig(Consumer<AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails.Builder> zoneAwarenessConfig)

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

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

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

Parameters:

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

Returns:

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

See Also:

• zoneAwarenessConfig(AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails)

dedicatedMasterCount

AwsOpenSearchServiceDomainClusterConfigDetails.Builder dedicatedMasterCount(Integer dedicatedMasterCount)

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

Parameters:

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

Returns:

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

instanceType

AwsOpenSearchServiceDomainClusterConfigDetails.Builder instanceType(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.

Parameters:

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:

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

warmType

AwsOpenSearchServiceDomainClusterConfigDetails.Builder warmType(String warmType)

The type of UltraWarm instance.

Parameters:

warmType - The type of UltraWarm instance.

Returns:

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

zoneAwarenessEnabled

AwsOpenSearchServiceDomainClusterConfigDetails.Builder zoneAwarenessEnabled(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.

Parameters:

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:

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

dedicatedMasterType

AwsOpenSearchServiceDomainClusterConfigDetails.Builder dedicatedMasterType(String dedicatedMasterType)

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

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

Parameters:

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

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

Returns:

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