software.amazon.awscdk.services.opensearchservice

Interface CapacityConfig

All Known Implementing Classes:

CapacityConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:24.959Z")
public interface CapacityConfig

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())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CapacityConfig.Builder	builder()
default java.lang.String	getDataNodeInstanceType() The instance type for your data nodes, such as `m3.medium.search`.
default java.lang.Number	getDataNodes() The number of data nodes (instances) to use in the Amazon OpenSearch Service domain.
default java.lang.String	getMasterNodeInstanceType() The hardware configuration of the computer that hosts the dedicated master node, such as `m3.medium.search`.
default java.lang.Number	getMasterNodes() The number of instances to use for the master node.
default java.lang.String	getWarmInstanceType() The instance type for your UltraWarm node, such as `ultrawarm1.medium.search`.
default java.lang.Number	getWarmNodes() The number of UltraWarm nodes (instances) to use in the Amazon OpenSearch Service domain.

Method Detail

getDataNodeInstanceType

default java.lang.String getDataNodeInstanceType()

The instance type for your data nodes, such as `m3.medium.search`. For valid values, see [Supported Instance Types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) in the Amazon OpenSearch Service Developer Guide.

Default: - r5.large.search

getDataNodes

default java.lang.Number getDataNodes()

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

Default: - 1

getMasterNodeInstanceType

default java.lang.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] (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) in the Amazon OpenSearch Service Developer Guide.

Default: - r5.large.search

getMasterNodes

default java.lang.Number getMasterNodes()

The number of instances to use for the master node.

Default: - no dedicated master nodes

getWarmInstanceType

default java.lang.String getWarmInstanceType()

The instance type for your UltraWarm node, such as `ultrawarm1.medium.search`. For valid values, see [UltraWarm Storage Limits] (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#limits-ultrawarm) in the Amazon OpenSearch Service Developer Guide.

Default: - ultrawarm1.medium.search

getWarmNodes

default java.lang.Number getWarmNodes()

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

Default: - no UltraWarm nodes

builder

static CapacityConfig.Builder builder()

Returns:

a CapacityConfig.Builder of CapacityConfig