AWS::Elasticsearch::Domain ElasticsearchClusterConfig
The cluster configuration for the Amazon ES domain. You can specify options such as the instance type and the number of instances. For more information, see Configuring Amazon ES Domains in the Amazon Elasticsearch Service Developer Guide.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "DedicatedMasterCount" :
Integer
, "DedicatedMasterEnabled" :Boolean
, "DedicatedMasterType" :String
, "InstanceCount" :Integer
, "InstanceType" :String
, "WarmCount" :Integer
, "WarmEnabled" :Boolean
, "WarmType" :String
, "ZoneAwarenessConfig" :ZoneAwarenessConfig
, "ZoneAwarenessEnabled" :Boolean
}
YAML
DedicatedMasterCount:
Integer
DedicatedMasterEnabled:Boolean
DedicatedMasterType:String
InstanceCount:Integer
InstanceType:String
WarmCount:Integer
WarmEnabled:Boolean
WarmType:String
ZoneAwarenessConfig:ZoneAwarenessConfig
ZoneAwarenessEnabled:Boolean
Properties
DedicatedMasterCount
-
The number of instances to use for the master node. If you specify this property, you must specify true for the DedicatedMasterEnabled property.
Required: No
Type: Integer
Update requires: No interruption
DedicatedMasterEnabled
-
Indicates whether to use a dedicated master node for the Amazon ES 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.
Required: No
Type: Boolean
Update requires: No interruption
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 theDedicatedMasterEnabled
property. For valid values, see Supported Instance Types in the Amazon Elasticsearch Service Developer Guide.Required: No
Type: String
Update requires: No interruption
InstanceCount
-
The number of data nodes (instances) to use in the Amazon ES domain.
Required: No
Type: Integer
Update requires: No interruption
InstanceType
-
The instance type for your data nodes, such as
m3.medium.elasticsearch
. For valid values, see Supported Instance Types in the Amazon Elasticsearch Service Developer Guide.Required: No
Type: String
Update requires: No interruption
WarmCount
-
The number of warm nodes in the cluster.
Required: No
Type: Integer
Update requires: No interruption
WarmEnabled
-
Whether to enable warm storage for the cluster.
Required: No
Type: Boolean
Update requires: No interruption
WarmType
-
The instance type for the cluster's warm nodes.
Required: No
Type: String
Update requires: No interruption
ZoneAwarenessConfig
-
Specifies zone awareness configuration options. Only use if
ZoneAwarenessEnabled
istrue
.Required: No
Type: ZoneAwarenessConfig
Update requires: No interruption
ZoneAwarenessEnabled
-
Indicates whether to enable zone awareness for the Amazon ES domain. When you enable zone awareness, Amazon ES 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 the Amazon Elasticsearch Service Developer Guide.
Required: No
Type: Boolean
Update requires: No interruption