Interface CfnDomain.IElasticsearchClusterConfigProperty
The cluster configuration for the OpenSearch Service domain.
Namespace: Amazon.CDK.AWS.Elasticsearch
Assembly: Amazon.CDK.AWS.Elasticsearch.dll
Syntax (csharp)
public interface IElasticsearchClusterConfigProperty
Syntax (vb)
Public Interface 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 AWS::Elasticsearch::Domain
resource is being replaced by the AWS::OpenSearchService::Domain 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 New resource types in the Amazon OpenSearch Service Developer Guide .
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 |
InstanceCount | The number of data nodes (instances) to use in the OpenSearch Service domain. |
InstanceType | The instance type for your data nodes, such as |
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.
virtual object ColdStorageOptions { get; }
Property Value
System.Object
Remarks
DedicatedMasterCount
The number of instances to use for the master node.
virtual Nullable<double> DedicatedMasterCount { get; }
Property Value
System.Nullable<System.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.
virtual object DedicatedMasterEnabled { get; }
Property Value
System.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 .
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 .
virtual string DedicatedMasterType { get; }
Property Value
System.String
Remarks
InstanceCount
The number of data nodes (instances) to use in the OpenSearch Service domain.
virtual Nullable<double> InstanceCount { get; }
Property Value
System.Nullable<System.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 .
virtual string InstanceType { get; }
Property Value
System.String
Remarks
WarmCount
The number of warm nodes in the cluster.
virtual Nullable<double> WarmCount { get; }
Property Value
System.Nullable<System.Double>
Remarks
WarmEnabled
Whether to enable warm storage for the cluster.
virtual object WarmEnabled { get; }
Property Value
System.Object
Remarks
WarmType
The instance type for the cluster's warm nodes.
virtual string WarmType { get; }
Property Value
System.String
Remarks
ZoneAwarenessConfig
Specifies zone awareness configuration options.
virtual object ZoneAwarenessConfig { get; }
Property Value
System.Object
Remarks
ZoneAwarenessEnabled
Indicates whether to enable zone awareness for the OpenSearch Service domain.
virtual object ZoneAwarenessEnabled { get; }
Property Value
System.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 .