Class CfnDomain.ClusterConfigProperty
The cluster configuration for the OpenSearch Service domain.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.OpenSearchService
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ClusterConfigProperty : Object, CfnDomain.IClusterConfigProperty
Syntax (vb)
Public Class ClusterConfigProperty
Inherits Object
Implements CfnDomain.IClusterConfigProperty
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 .
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.OpenSearchService;
var clusterConfigProperty = new ClusterConfigProperty {
ColdStorageOptions = new ColdStorageOptionsProperty {
Enabled = false
},
DedicatedMasterCount = 123,
DedicatedMasterEnabled = false,
DedicatedMasterType = "dedicatedMasterType",
InstanceCount = 123,
InstanceType = "instanceType",
MultiAzWithStandbyEnabled = false,
WarmCount = 123,
WarmEnabled = false,
WarmType = "warmType",
ZoneAwarenessConfig = new ZoneAwarenessConfigProperty {
AvailabilityZoneCount = 123
},
ZoneAwarenessEnabled = false
};
Synopsis
Constructors
ClusterConfigProperty() |
Properties
ColdStorageOptions | Container for cold storage configuration options. |
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 |
MultiAzWithStandbyEnabled | Indicates whether Multi-AZ with Standby deployment option is enabled. |
WarmCount | The number of warm nodes in the cluster. |
WarmEnabled | Whether to enable UltraWarm 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. |
Constructors
ClusterConfigProperty()
public ClusterConfigProperty()
Properties
ColdStorageOptions
Container for cold storage configuration options.
public object ColdStorageOptions { get; set; }
Property Value
System.Object
Remarks
DedicatedMasterCount
The number of instances to use for the master node.
public Nullable<double> DedicatedMasterCount { get; set; }
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.
public object DedicatedMasterEnabled { get; set; }
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.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 .
public string DedicatedMasterType { get; set; }
Property Value
System.String
Remarks
InstanceCount
The number of data nodes (instances) to use in the OpenSearch Service domain.
public Nullable<double> InstanceCount { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
InstanceType
The instance type for your data nodes, such as m3.medium.search
. For valid values, see Supported instance types in Amazon OpenSearch Service .
public string InstanceType { get; set; }
Property Value
System.String
Remarks
MultiAzWithStandbyEnabled
Indicates whether Multi-AZ with Standby deployment option is enabled.
public object MultiAzWithStandbyEnabled { get; set; }
Property Value
System.Object
Remarks
WarmCount
The number of warm nodes in the cluster.
public Nullable<double> WarmCount { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
WarmEnabled
Whether to enable UltraWarm storage for the cluster.
public object WarmEnabled { get; set; }
Property Value
System.Object
Remarks
WarmType
The instance type for the cluster's warm nodes.
public string WarmType { get; set; }
Property Value
System.String
Remarks
ZoneAwarenessConfig
Specifies zone awareness configuration options.
public object ZoneAwarenessConfig { get; set; }
Property Value
System.Object
Remarks
Only use if ZoneAwarenessEnabled
is true
.
ZoneAwarenessEnabled
Indicates whether to enable zone awareness for the OpenSearch Service domain.
public object ZoneAwarenessEnabled { get; set; }
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 .