Package software.amazon.awscdk.services.opensearchservice

Class CapacityConfig.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchservice.CapacityConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CapacityConfig>

Enclosing interface:

CapacityConfig

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

A builder for CapacityConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CapacityConfig	build()	Builds the configured instance.
CapacityConfig.Builder	dataNodeInstanceType(String dataNodeInstanceType)	Sets the value of CapacityConfig.getDataNodeInstanceType()
CapacityConfig.Builder	dataNodes(Number dataNodes)	Sets the value of CapacityConfig.getDataNodes()
CapacityConfig.Builder	masterNodeInstanceType(String masterNodeInstanceType)	Sets the value of CapacityConfig.getMasterNodeInstanceType()
CapacityConfig.Builder	masterNodes(Number masterNodes)	Sets the value of CapacityConfig.getMasterNodes()
CapacityConfig.Builder	multiAzWithStandbyEnabled(Boolean multiAzWithStandbyEnabled)	Sets the value of CapacityConfig.getMultiAzWithStandbyEnabled()
CapacityConfig.Builder	nodeOptions(List<? extends NodeOptions> nodeOptions)	Sets the value of CapacityConfig.getNodeOptions()
CapacityConfig.Builder	warmInstanceType(String warmInstanceType)	Sets the value of CapacityConfig.getWarmInstanceType()
CapacityConfig.Builder	warmNodes(Number warmNodes)	Sets the value of CapacityConfig.getWarmNodes()

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

dataNodeInstanceType

@Stability(Stable)
public CapacityConfig.Builder dataNodeInstanceType(String dataNodeInstanceType)

Sets the value of CapacityConfig.getDataNodeInstanceType()

Parameters:

dataNodeInstanceType - The instance type for your data nodes, such as m3.medium.search. For valid values, see Supported Instance Types in the Amazon OpenSearch Service Developer Guide.

Returns:

this

dataNodes

@Stability(Stable)
public CapacityConfig.Builder dataNodes(Number dataNodes)

Sets the value of CapacityConfig.getDataNodes()

Parameters:

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

Returns:

this

masterNodeInstanceType

@Stability(Stable)
public CapacityConfig.Builder masterNodeInstanceType(String masterNodeInstanceType)

Sets the value of CapacityConfig.getMasterNodeInstanceType()

Parameters:

masterNodeInstanceType - The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search. For valid values, see Supported Instance Types in the Amazon OpenSearch Service Developer Guide.

Returns:

this

masterNodes

@Stability(Stable)
public CapacityConfig.Builder masterNodes(Number masterNodes)

Sets the value of CapacityConfig.getMasterNodes()

Parameters:

masterNodes - The number of instances to use for the master node.

Returns:

this

multiAzWithStandbyEnabled

@Stability(Stable)
public CapacityConfig.Builder multiAzWithStandbyEnabled(Boolean multiAzWithStandbyEnabled)

Sets the value of CapacityConfig.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 CapacityConfig.Builder nodeOptions(List<? extends NodeOptions> nodeOptions)

Sets the value of CapacityConfig.getNodeOptions()

Parameters:

nodeOptions - Additional node options for the domain.

Returns:

this

warmInstanceType

@Stability(Stable)
public CapacityConfig.Builder warmInstanceType(String warmInstanceType)

Sets the value of CapacityConfig.getWarmInstanceType()

Parameters:

warmInstanceType - The instance type for your UltraWarm node, such as ultrawarm1.medium.search. For valid values, see UltraWarm Storage Limits in the Amazon OpenSearch Service Developer Guide.

Returns:

this

warmNodes

@Stability(Stable)
public CapacityConfig.Builder warmNodes(Number warmNodes)

Sets the value of CapacityConfig.getWarmNodes()

Parameters:

warmNodes - The number of UltraWarm nodes (instances) to use in the Amazon OpenSearch Service domain.

Returns:

this

build

@Stability(Stable)
public CapacityConfig build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CapacityConfig>

Returns:

a new instance of CapacityConfig

Throws:

NullPointerException - if any required attribute was not provided