Skip to content
v2.274.0

CapacityConfig Struct ​

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

Example ​

ts
import * as opensearch from 'aws-cdk-lib/aws-opensearchservice';

const domain = new Domain(this, 'Domain', {
  version: EngineVersion.OPENSEARCH_1_3,
  capacity: {
    nodeOptions: [
      {
        nodeType: opensearch.NodeType.COORDINATOR,
        nodeConfig: {
          enabled: true,
          count: 2,
          type: 'm5.large.search',
        },
      },
    ],
  },
})

Properties ​

dataNodeInstanceTypeoptionalstringdata_node_instance_typeoptionalstrdataNodeInstanceTypeoptionalStringDataNodeInstanceTypeoptionalstringDataNodeInstanceTypeoptional*string= r5.large.search#
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.
dataNodesoptionalnumberdata_nodesoptionalint | floatdataNodesoptionalNumberDataNodesoptionaldoubleDataNodesoptional*float64= 1#
The number of data nodes (instances) to use in the Amazon OpenSearch Service domain.
masterNodeInstanceTypeoptionalstringmaster_node_instance_typeoptionalstrmasterNodeInstanceTypeoptionalStringMasterNodeInstanceTypeoptionalstringMasterNodeInstanceTypeoptional*string= r5.large.search#
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.
masterNodesoptionalnumbermaster_nodesoptionalint | floatmasterNodesoptionalNumberMasterNodesoptionaldoubleMasterNodesoptional*float64#
The number of instances to use for the master node.

Default: no dedicated master nodes

multiAzWithStandbyEnabledoptionalbooleanmulti_az_with_standby_enabledoptionalboolmultiAzWithStandbyEnabledoptionalBooleanMultiAzWithStandbyEnabledoptionalboolMultiAzWithStandbyEnabledoptional*bool#
Indicates whether Multi-AZ with Standby deployment option is enabled.

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

For more information, see Multi-AZ with Standby

nodeOptionsoptionalNodeOptions[]node_optionsoptionaltyping.List[NodeOptions]nodeOptionsoptionalList<NodeOptions>NodeOptionsoptionalNodeOptions[]NodeOptionsoptional*[]NodeOptions#
Additional node options for the domain.

Default: no additional node options

warmInstanceTypeoptionalstringwarm_instance_typeoptionalstrwarmInstanceTypeoptionalStringWarmInstanceTypeoptionalstringWarmInstanceTypeoptional*string= ultrawarm1.medium.search#
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.
warmNodesoptionalnumberwarm_nodesoptionalint | floatwarmNodesoptionalNumberWarmNodesoptionaldoubleWarmNodesoptional*float64#
The number of UltraWarm nodes (instances) to use in the Amazon OpenSearch Service domain.

Default: no UltraWarm nodes