Interface CfnDomain.IElasticsearchClusterConfigProperty

The cluster configuration for the OpenSearch Service domain.

Namespace: Amazon.CDK.AWS.Elasticsearch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnDomain.IElasticsearchClusterConfigProperty

Syntax (vb)

Public Interface CfnDomain.IElasticsearchClusterConfigProperty

Remarks

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 .

The <code>AWS::Elasticsearch::Domain</code> resource is being replaced by the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html">AWS::OpenSearchService::Domain</a> resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource">New resource types</a> in the <em>Amazon OpenSearch Service Developer Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Elasticsearch;

             var elasticsearchClusterConfigProperty = new ElasticsearchClusterConfigProperty {
                 ColdStorageOptions = new ColdStorageOptionsProperty {
                     Enabled = false
                 },
                 DedicatedMasterCount = 123,
                 DedicatedMasterEnabled = false,
                 DedicatedMasterType = "dedicatedMasterType",
                 InstanceCount = 123,
                 InstanceType = "instanceType",
                 WarmCount = 123,
                 WarmEnabled = false,
                 WarmType = "warmType",
                 ZoneAwarenessConfig = new ZoneAwarenessConfigProperty {
                     AvailabilityZoneCount = 123
                 },
                 ZoneAwarenessEnabled = false
             };

Synopsis

Properties

ColdStorageOptions	Specifies cold storage options for the domain.
DedicatedMasterCount	The number of instances to use for the master node.
DedicatedMasterEnabled	Indicates whether to use a dedicated master node for the OpenSearch Service domain.
DedicatedMasterType	The hardware configuration of the computer that hosts the dedicated master node, such as `m3.medium.elasticsearch` . 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	The number of data nodes (instances) to use in the OpenSearch Service domain.
InstanceType	The instance type for your data nodes, such as `m3.medium.elasticsearch` . For valid values, see Supported instance types in Amazon OpenSearch Service .
WarmCount	The number of warm nodes in the cluster.
WarmEnabled	Whether to enable warm storage for the cluster.
WarmType	The instance type for the cluster's warm nodes.
ZoneAwarenessConfig	Specifies zone awareness configuration options.
ZoneAwarenessEnabled	Indicates whether to enable zone awareness for the OpenSearch Service domain.

Properties

ColdStorageOptions

Specifies cold storage options for the domain.

object? ColdStorageOptions { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-coldstorageoptions

Type union: either IResolvable or CfnDomain.IColdStorageOptionsProperty

DedicatedMasterCount

The number of instances to use for the master node.

double? DedicatedMasterCount { get; }

Property Value

double?

Remarks

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

DedicatedMasterEnabled

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

object? DedicatedMasterEnabled { get; }

Property Value

object

Remarks

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 .

Type union: either bool or IResolvable

DedicatedMasterType

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

string? DedicatedMasterType { get; }

Property Value

string

Remarks

InstanceCount

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

double? InstanceCount { get; }

Property Value

double?

Remarks

InstanceType

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

string? InstanceType { get; }

Property Value

string

Remarks

WarmCount

The number of warm nodes in the cluster.

double? WarmCount { get; }

Property Value

double?

Remarks

Required if you enable warm storage.

WarmEnabled

Whether to enable warm storage for the cluster.

object? WarmEnabled { get; }

Property Value

object

Remarks

Type union: either bool or IResolvable

WarmType

The instance type for the cluster's warm nodes.

string? WarmType { get; }

Property Value

string

Remarks

Required if you enable warm storage.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-warmtype

ZoneAwarenessConfig

Specifies zone awareness configuration options.

object? ZoneAwarenessConfig { get; }

Property Value

object

Remarks

Only use if ZoneAwarenessEnabled is true .

Type union: either IResolvable or CfnDomain.IZoneAwarenessConfigProperty

ZoneAwarenessEnabled

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

object? ZoneAwarenessEnabled { get; }

Property Value

object

Remarks

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 .

Type union: either bool or IResolvable