aws-cdk-lib.aws_opensearchservice.CfnDomain.ClusterConfigProperty

interface ClusterConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.OpenSearchService.CfnDomain.ClusterConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsopensearchservice#CfnDomain_ClusterConfigProperty
Javasoftware.amazon.awscdk.services.opensearchservice.CfnDomain.ClusterConfigProperty
Pythonaws_cdk.aws_opensearchservice.CfnDomain.ClusterConfigProperty
TypeScript aws-cdk-lib » aws_opensearchservice » CfnDomain » ClusterConfigProperty

The cluster configuration for the OpenSearch Service domain.

You can specify options such as the instance type and the number of instances. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearchservice as opensearchservice } from 'aws-cdk-lib';
const clusterConfigProperty: opensearchservice.CfnDomain.ClusterConfigProperty = {
  dedicatedMasterCount: 123,
  dedicatedMasterEnabled: false,
  dedicatedMasterType: 'dedicatedMasterType',
  instanceCount: 123,
  instanceType: 'instanceType',
  multiAzWithStandbyEnabled: false,
  warmCount: 123,
  warmEnabled: false,
  warmType: 'warmType',
  zoneAwarenessConfig: {
    availabilityZoneCount: 123,
  },
  zoneAwarenessEnabled: false,
};

Properties

NameTypeDescription
dedicatedMasterCount?numberThe number of instances to use for the master node.
dedicatedMasterEnabled?boolean | IResolvableIndicates whether to use a dedicated master node for the OpenSearch Service domain.
dedicatedMasterType?stringThe hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search . If you specify this property, you must specify true for the DedicatedMasterEnabled property. For valid values, see Supported instance types in Amazon OpenSearch Service .
instanceCount?numberThe number of data nodes (instances) to use in the OpenSearch Service domain.
instanceType?stringThe instance type for your data nodes, such as m3.medium.search . For valid values, see Supported instance types in Amazon OpenSearch Service .
multiAzWithStandbyEnabled?boolean | IResolvableIndicates whether Multi-AZ with Standby deployment option is enabled.
warmCount?numberThe number of warm nodes in the cluster.
warmEnabled?boolean | IResolvableWhether to enable UltraWarm storage for the cluster.
warmType?stringThe instance type for the cluster's warm nodes.
zoneAwarenessConfig?IResolvable | ZoneAwarenessConfigPropertySpecifies zone awareness configuration options.
zoneAwarenessEnabled?boolean | IResolvableIndicates whether to enable zone awareness for the OpenSearch Service domain.

dedicatedMasterCount?

Type: number (optional)

The number of instances to use for the master node.

If you specify this property, you must specify true for the DedicatedMasterEnabled property.


dedicatedMasterEnabled?

Type: boolean | IResolvable (optional)

Indicates whether to use a dedicated master node for the OpenSearch Service domain.

A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. See Dedicated master nodes in Amazon OpenSearch Service .


dedicatedMasterType?

Type: string (optional)

The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search . If you specify this property, you must specify true for the DedicatedMasterEnabled property. For valid values, see Supported instance types in Amazon OpenSearch Service .


instanceCount?

Type: number (optional)

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


instanceType?

Type: string (optional)

The instance type for your data nodes, such as m3.medium.search . For valid values, see Supported instance types in Amazon OpenSearch Service .


multiAzWithStandbyEnabled?

Type: boolean | IResolvable (optional)

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

For more information, see Multi-AZ with Standby .


warmCount?

Type: number (optional)

The number of warm nodes in the cluster.


warmEnabled?

Type: boolean | IResolvable (optional)

Whether to enable UltraWarm storage for the cluster.

See UltraWarm storage for Amazon OpenSearch Service .


warmType?

Type: string (optional)

The instance type for the cluster's warm nodes.


zoneAwarenessConfig?

Type: IResolvable | ZoneAwarenessConfigProperty (optional)

Specifies zone awareness configuration options.

Only use if ZoneAwarenessEnabled is true .


zoneAwarenessEnabled?

Type: boolean | IResolvable (optional)

Indicates whether to enable zone awareness for the OpenSearch Service domain.

When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .