interface CapacityConfig

Language	Type name
.NET	Amazon.CDK.AWS.OpenSearchService.CapacityConfig
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsopensearchservice#CapacityConfig
Java	software.amazon.awscdk.services.opensearchservice.CapacityConfig
Python	aws_cdk.aws_opensearchservice.CapacityConfig
TypeScript (source)	aws-cdk-lib » aws_opensearchservice » CapacityConfig

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

Example

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

Name	Type	Description
dataNodeInstanceType?	string	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.
dataNodes?	number	The number of data nodes (instances) to use in the Amazon OpenSearch Service domain.
masterNodeInstanceType?	string	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.
masterNodes?	number	The number of instances to use for the master node.
multiAzWithStandbyEnabled?	boolean	Indicates whether Multi-AZ with Standby deployment option is enabled.
nodeOptions?	NodeOptions[]	Additional node options for the domain.
warmInstanceType?	string	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.
warmNodes?	number	The number of UltraWarm nodes (instances) to use in the Amazon OpenSearch Service domain.

---

dataNodeInstanceType?

Type: string (optional, default: r5.large.search)

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.

---

dataNodes?

Type: number (optional, default: 1)

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

---

masterNodeInstanceType?

Type: string (optional, default: 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 in the Amazon OpenSearch Service Developer Guide.

---

masterNodes?

Type: number (optional, default: no dedicated master nodes)

The number of instances to use for the master node.

---

multiAzWithStandbyEnabled?

Type: boolean (optional, default: multi-az with standby if the feature flag ENABLE_OPENSEARCH_MULTIAZ_WITH_STANDBY is true, no multi-az with standby otherwise)

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

For more information, see Multi-AZ with Standby

---

nodeOptions?

Type: NodeOptions[] (optional, default: no additional node options)

Additional node options for the domain.

---

warmInstanceType?

Type: string (optional, default: ultrawarm1.medium.search)

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.

---

warmNodes?

Type: number (optional, default: no UltraWarm nodes)

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