aws-cdk-lib.aws_opensearchservice.CapacityConfig

interface CapacityConfig

LanguageType name
.NETAmazon.CDK.AWS.OpenSearchService.CapacityConfig
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsopensearchservice#CapacityConfig
Javasoftware.amazon.awscdk.services.opensearchservice.CapacityConfig
Pythonaws_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

const domain = new Domain(this, 'Domain', {
  version: EngineVersion.OPENSEARCH_1_0,
  capacity: {
    masterNodes: 2,
    warmNodes: 2,
    warmInstanceType: 'ultrawarm1.medium.search',
  },
});

Properties

NameTypeDescription
dataNodeInstanceType?stringThe 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?numberThe number of data nodes (instances) to use in the Amazon OpenSearch Service domain.
masterNodeInstanceType?stringThe 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.
masterNodes?numberThe number of instances to use for the master node.
warmInstanceType?stringThe 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.
warmNodes?numberThe 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] (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) 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.


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] (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#limits-ultrawarm) 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.