Package software.amazon.awscdk.services.opensearchservice

Class CfnDomain.ClusterConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchservice.CfnDomain.ClusterConfigProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomain.ClusterConfigProperty>

Enclosing interface:

CfnDomain.ClusterConfigProperty

@Stability(Stable)
public static final class CfnDomain.ClusterConfigProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDomain.ClusterConfigProperty>

A builder for CfnDomain.ClusterConfigProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDomain.ClusterConfigProperty	build()	Builds the configured instance.
CfnDomain.ClusterConfigProperty.Builder	dedicatedMasterCount(Number dedicatedMasterCount)	Sets the value of CfnDomain.ClusterConfigProperty.getDedicatedMasterCount()
CfnDomain.ClusterConfigProperty.Builder	dedicatedMasterEnabled(Boolean dedicatedMasterEnabled)	Sets the value of CfnDomain.ClusterConfigProperty.getDedicatedMasterEnabled()
CfnDomain.ClusterConfigProperty.Builder	dedicatedMasterEnabled(IResolvable dedicatedMasterEnabled)	Sets the value of CfnDomain.ClusterConfigProperty.getDedicatedMasterEnabled()
CfnDomain.ClusterConfigProperty.Builder	dedicatedMasterType(String dedicatedMasterType)	Sets the value of CfnDomain.ClusterConfigProperty.getDedicatedMasterType()
CfnDomain.ClusterConfigProperty.Builder	instanceCount(Number instanceCount)	Sets the value of CfnDomain.ClusterConfigProperty.getInstanceCount()
CfnDomain.ClusterConfigProperty.Builder	instanceType(String instanceType)	Sets the value of CfnDomain.ClusterConfigProperty.getInstanceType()
CfnDomain.ClusterConfigProperty.Builder	multiAzWithStandbyEnabled(Boolean multiAzWithStandbyEnabled)	Sets the value of CfnDomain.ClusterConfigProperty.getMultiAzWithStandbyEnabled()
CfnDomain.ClusterConfigProperty.Builder	multiAzWithStandbyEnabled(IResolvable multiAzWithStandbyEnabled)	Sets the value of CfnDomain.ClusterConfigProperty.getMultiAzWithStandbyEnabled()
CfnDomain.ClusterConfigProperty.Builder	warmCount(Number warmCount)	Sets the value of CfnDomain.ClusterConfigProperty.getWarmCount()
CfnDomain.ClusterConfigProperty.Builder	warmEnabled(Boolean warmEnabled)	Sets the value of CfnDomain.ClusterConfigProperty.getWarmEnabled()
CfnDomain.ClusterConfigProperty.Builder	warmEnabled(IResolvable warmEnabled)	Sets the value of CfnDomain.ClusterConfigProperty.getWarmEnabled()
CfnDomain.ClusterConfigProperty.Builder	warmType(String warmType)	Sets the value of CfnDomain.ClusterConfigProperty.getWarmType()
CfnDomain.ClusterConfigProperty.Builder	zoneAwarenessConfig(IResolvable zoneAwarenessConfig)	Sets the value of CfnDomain.ClusterConfigProperty.getZoneAwarenessConfig()
CfnDomain.ClusterConfigProperty.Builder	zoneAwarenessConfig(CfnDomain.ZoneAwarenessConfigProperty zoneAwarenessConfig)	Sets the value of CfnDomain.ClusterConfigProperty.getZoneAwarenessConfig()
CfnDomain.ClusterConfigProperty.Builder	zoneAwarenessEnabled(Boolean zoneAwarenessEnabled)	Sets the value of CfnDomain.ClusterConfigProperty.getZoneAwarenessEnabled()
CfnDomain.ClusterConfigProperty.Builder	zoneAwarenessEnabled(IResolvable zoneAwarenessEnabled)	Sets the value of CfnDomain.ClusterConfigProperty.getZoneAwarenessEnabled()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

dedicatedMasterCount

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder dedicatedMasterCount(Number dedicatedMasterCount)

Sets the value of CfnDomain.ClusterConfigProperty.getDedicatedMasterCount()

Parameters:

dedicatedMasterCount - The number of instances to use for the master node. If you specify this property, you must specify true for the DedicatedMasterEnabled property.

Returns:

this

dedicatedMasterEnabled

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder dedicatedMasterEnabled(Boolean dedicatedMasterEnabled)

Sets the value of CfnDomain.ClusterConfigProperty.getDedicatedMasterEnabled()

Parameters:

dedicatedMasterEnabled - Indicates whether to use a dedicated master node for the OpenSearch Service domain. A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. See Dedicated master nodes in Amazon OpenSearch Service .

Returns:

this

dedicatedMasterEnabled

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder dedicatedMasterEnabled(IResolvable dedicatedMasterEnabled)

Sets the value of CfnDomain.ClusterConfigProperty.getDedicatedMasterEnabled()

Parameters:

dedicatedMasterEnabled - Indicates whether to use a dedicated master node for the OpenSearch Service domain. A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. See Dedicated master nodes in Amazon OpenSearch Service .

Returns:

this

dedicatedMasterType

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder dedicatedMasterType(String dedicatedMasterType)

Sets the value of CfnDomain.ClusterConfigProperty.getDedicatedMasterType()

Parameters:

dedicatedMasterType - The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search . If you specify this property, you must specify true for the DedicatedMasterEnabled property. For valid values, see Supported instance types in Amazon OpenSearch Service .

Returns:

this

instanceCount

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder instanceCount(Number instanceCount)

Sets the value of CfnDomain.ClusterConfigProperty.getInstanceCount()

Parameters:

instanceCount - The number of data nodes (instances) to use in the OpenSearch Service domain.

Returns:

this

instanceType

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder instanceType(String instanceType)

Sets the value of CfnDomain.ClusterConfigProperty.getInstanceType()

Parameters:

instanceType - The instance type for your data nodes, such as m3.medium.search . For valid values, see Supported instance types in Amazon OpenSearch Service .

Returns:

this

multiAzWithStandbyEnabled

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder multiAzWithStandbyEnabled(Boolean multiAzWithStandbyEnabled)

Sets the value of CfnDomain.ClusterConfigProperty.getMultiAzWithStandbyEnabled()

Parameters:

multiAzWithStandbyEnabled - Indicates whether Multi-AZ with Standby deployment option is enabled. For more information, see Multi-AZ with Standby .

Returns:

this

multiAzWithStandbyEnabled

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder multiAzWithStandbyEnabled(IResolvable multiAzWithStandbyEnabled)

Sets the value of CfnDomain.ClusterConfigProperty.getMultiAzWithStandbyEnabled()

Parameters:

multiAzWithStandbyEnabled - Indicates whether Multi-AZ with Standby deployment option is enabled. For more information, see Multi-AZ with Standby .

Returns:

this

warmCount

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder warmCount(Number warmCount)

Sets the value of CfnDomain.ClusterConfigProperty.getWarmCount()

Parameters:

warmCount - The number of warm nodes in the cluster.

Returns:

this

warmEnabled

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder warmEnabled(Boolean warmEnabled)

Sets the value of CfnDomain.ClusterConfigProperty.getWarmEnabled()

Parameters:

warmEnabled - Whether to enable UltraWarm storage for the cluster. See UltraWarm storage for Amazon OpenSearch Service .

Returns:

this

warmEnabled

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder warmEnabled(IResolvable warmEnabled)

Sets the value of CfnDomain.ClusterConfigProperty.getWarmEnabled()

Parameters:

warmEnabled - Whether to enable UltraWarm storage for the cluster. See UltraWarm storage for Amazon OpenSearch Service .

Returns:

this

warmType

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder warmType(String warmType)

Sets the value of CfnDomain.ClusterConfigProperty.getWarmType()

Parameters:

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

Returns:

this

zoneAwarenessConfig

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder zoneAwarenessConfig(IResolvable zoneAwarenessConfig)

Sets the value of CfnDomain.ClusterConfigProperty.getZoneAwarenessConfig()

Parameters:

zoneAwarenessConfig - Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true .

Returns:

this

zoneAwarenessConfig

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder zoneAwarenessConfig(CfnDomain.ZoneAwarenessConfigProperty zoneAwarenessConfig)

Sets the value of CfnDomain.ClusterConfigProperty.getZoneAwarenessConfig()

Parameters:

zoneAwarenessConfig - Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true .

Returns:

this

zoneAwarenessEnabled

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder zoneAwarenessEnabled(Boolean zoneAwarenessEnabled)

Sets the value of CfnDomain.ClusterConfigProperty.getZoneAwarenessEnabled()

Parameters:

zoneAwarenessEnabled - Indicates whether to enable zone awareness for the OpenSearch Service domain. When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

Returns:

this

zoneAwarenessEnabled

@Stability(Stable)
public CfnDomain.ClusterConfigProperty.Builder zoneAwarenessEnabled(IResolvable zoneAwarenessEnabled)

Sets the value of CfnDomain.ClusterConfigProperty.getZoneAwarenessEnabled()

Parameters:

zoneAwarenessEnabled - Indicates whether to enable zone awareness for the OpenSearch Service domain. When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

Returns:

this

build

@Stability(Stable)
public CfnDomain.ClusterConfigProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDomain.ClusterConfigProperty>

Returns:

a new instance of CfnDomain.ClusterConfigProperty

Throws:

NullPointerException - if any required attribute was not provided