Package software.amazon.awscdk.cfnpropertymixins.services.opensearchservice

Class CfnDomainPropsMixin.ClusterConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.opensearchservice.CfnDomainPropsMixin.ClusterConfigProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnDomainPropsMixin.ClusterConfigProperty

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

A builder for CfnDomainPropsMixin.ClusterConfigProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDomainPropsMixin.ClusterConfigProperty	build()	Builds the configured instance.
CfnDomainPropsMixin.ClusterConfigProperty.Builder	coldStorageOptions(CfnDomainPropsMixin.ColdStorageOptionsProperty coldStorageOptions)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getColdStorageOptions()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	coldStorageOptions(IResolvable coldStorageOptions)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getColdStorageOptions()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	dedicatedMasterCount(Number dedicatedMasterCount)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getDedicatedMasterCount()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	dedicatedMasterEnabled(Boolean dedicatedMasterEnabled)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getDedicatedMasterEnabled()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	dedicatedMasterEnabled(IResolvable dedicatedMasterEnabled)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getDedicatedMasterEnabled()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	dedicatedMasterType(String dedicatedMasterType)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getDedicatedMasterType()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	instanceCount(Number instanceCount)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getInstanceCount()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	instanceType(String instanceType)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getInstanceType()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	multiAzWithStandbyEnabled(Boolean multiAzWithStandbyEnabled)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getMultiAzWithStandbyEnabled()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	multiAzWithStandbyEnabled(IResolvable multiAzWithStandbyEnabled)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getMultiAzWithStandbyEnabled()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	nodeOptions(List<? extends Object> nodeOptions)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getNodeOptions()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	nodeOptions(IResolvable nodeOptions)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getNodeOptions()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	warmCount(Number warmCount)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getWarmCount()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	warmEnabled(Boolean warmEnabled)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getWarmEnabled()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	warmEnabled(IResolvable warmEnabled)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getWarmEnabled()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	warmType(String warmType)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getWarmType()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	zoneAwarenessConfig(CfnDomainPropsMixin.ZoneAwarenessConfigProperty zoneAwarenessConfig)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getZoneAwarenessConfig()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	zoneAwarenessConfig(IResolvable zoneAwarenessConfig)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getZoneAwarenessConfig()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	zoneAwarenessEnabled(Boolean zoneAwarenessEnabled)	Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getZoneAwarenessEnabled()
CfnDomainPropsMixin.ClusterConfigProperty.Builder	zoneAwarenessEnabled(IResolvable zoneAwarenessEnabled)	Sets the value of CfnDomainPropsMixin.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

coldStorageOptions

@Stability(Stable)
public CfnDomainPropsMixin.ClusterConfigProperty.Builder coldStorageOptions(IResolvable coldStorageOptions)

Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getColdStorageOptions()

Parameters:

coldStorageOptions - Container for cold storage configuration options.

Returns:

this

coldStorageOptions

@Stability(Stable)
public CfnDomainPropsMixin.ClusterConfigProperty.Builder coldStorageOptions(CfnDomainPropsMixin.ColdStorageOptionsProperty coldStorageOptions)

Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getColdStorageOptions()

Parameters:

coldStorageOptions - Container for cold storage configuration options.

Returns:

this

dedicatedMasterCount

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

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.ClusterConfigProperty.Builder dedicatedMasterEnabled(Boolean dedicatedMasterEnabled)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.ClusterConfigProperty.Builder dedicatedMasterEnabled(IResolvable dedicatedMasterEnabled)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.ClusterConfigProperty.Builder dedicatedMasterType(String dedicatedMasterType)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.ClusterConfigProperty.Builder instanceCount(Number instanceCount)

Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getInstanceCount()

Parameters:

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

Returns:

this

instanceType

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

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.ClusterConfigProperty.Builder multiAzWithStandbyEnabled(Boolean multiAzWithStandbyEnabled)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.ClusterConfigProperty.Builder multiAzWithStandbyEnabled(IResolvable multiAzWithStandbyEnabled)

Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getMultiAzWithStandbyEnabled()

Parameters:

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

Returns:

this

nodeOptions

@Stability(Stable)
public CfnDomainPropsMixin.ClusterConfigProperty.Builder nodeOptions(IResolvable nodeOptions)

Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getNodeOptions()

Parameters:

nodeOptions - List of node options for the domain.

Returns:

this

nodeOptions

@Stability(Stable)
public CfnDomainPropsMixin.ClusterConfigProperty.Builder nodeOptions(List<? extends Object> nodeOptions)

Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getNodeOptions()

Parameters:

nodeOptions - List of node options for the domain.

Returns:

this

warmCount

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

Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getWarmCount()

Parameters:

warmCount - The number of warm nodes in the cluster.

Returns:

this

warmEnabled

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

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.ClusterConfigProperty.Builder warmEnabled(IResolvable warmEnabled)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.ClusterConfigProperty.Builder warmType(String warmType)

Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getWarmType()

Parameters:

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

Returns:

this

zoneAwarenessConfig

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

Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getZoneAwarenessConfig()

Parameters:

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

Returns:

this

zoneAwarenessConfig

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

Sets the value of CfnDomainPropsMixin.ClusterConfigProperty.getZoneAwarenessConfig()

Parameters:

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

Returns:

this

zoneAwarenessEnabled

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

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.ClusterConfigProperty.Builder zoneAwarenessEnabled(IResolvable zoneAwarenessEnabled)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.ClusterConfigProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDomainPropsMixin.ClusterConfigProperty

Throws:

NullPointerException - if any required attribute was not provided