Package software.amazon.awscdk.services.opensearchservice

Interface CapacityConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CapacityConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:19.139Z")
@Stability(Stable)
public interface CapacityConfig
extends software.amazon.jsii.JsiiSerializable

Configures the capacity of the cluster such as the instance type and the number of instances.

Example:

 Domain domain = Domain.Builder.create(this, "Domain")
         .version(EngineVersion.OPENSEARCH_1_0)
         .capacity(CapacityConfig.builder()
                 .masterNodes(2)
                 .warmNodes(2)
                 .warmInstanceType("ultrawarm1.medium.search")
                 .build())
         .coldStorageEnabled(true)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CapacityConfig.Builder	A builder for CapacityConfig
static final class	CapacityConfig.Jsii$Proxy	An implementation for CapacityConfig

Method Summary

Modifier and Type	Method	Description
static CapacityConfig.Builder	builder()
default String	getDataNodeInstanceType()	The instance type for your data nodes, such as m3.medium.search.
default Number	getDataNodes()	The number of data nodes (instances) to use in the Amazon OpenSearch Service domain.
default String	getMasterNodeInstanceType()	The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search.
default Number	getMasterNodes()	The number of instances to use for the master node.
default Boolean	getMultiAzWithStandbyEnabled()	Indicates whether Multi-AZ with Standby deployment option is enabled.
default String	getWarmInstanceType()	The instance type for your UltraWarm node, such as ultrawarm1.medium.search.
default Number	getWarmNodes()	The number of UltraWarm nodes (instances) to use in the Amazon OpenSearch Service domain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataNodeInstanceType

@Stability(Stable)
@Nullable
default String getDataNodeInstanceType()

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.

Default: - r5.large.search

getDataNodes

@Stability(Stable)
@Nullable
default Number getDataNodes()

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

Default: - 1

getMasterNodeInstanceType

@Stability(Stable)
@Nullable
default String getMasterNodeInstanceType()

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.

Default: - r5.large.search

getMasterNodes

@Stability(Stable)
@Nullable
default Number getMasterNodes()

The number of instances to use for the master node.

Default: - no dedicated master nodes

getMultiAzWithStandbyEnabled

@Stability(Stable)
@Nullable
default Boolean getMultiAzWithStandbyEnabled()

Indicates whether Multi-AZ with Standby deployment option is enabled.

For more information, see Multi-AZ with Standby

Default: - multi-az with standby if the feature flag `ENABLE_OPENSEARCH_MULTIAZ_WITH_STANDBY` is true, no multi-az with standby otherwise

getWarmInstanceType

@Stability(Stable)
@Nullable
default String getWarmInstanceType()

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.

Default: - ultrawarm1.medium.search

getWarmNodes

@Stability(Stable)
@Nullable
default Number getWarmNodes()

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

Default: - no UltraWarm nodes

builder

@Stability(Stable)
static CapacityConfig.Builder builder()

Returns:

a CapacityConfig.Builder of CapacityConfig