Interface CfnDomain.ElasticsearchClusterConfigProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDomain.ElasticsearchClusterConfigProperty.Jsii$Proxy
- Enclosing class:
- CfnDomain
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 .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.elasticsearch.*; ElasticsearchClusterConfigProperty elasticsearchClusterConfigProperty = ElasticsearchClusterConfigProperty.builder() .coldStorageOptions(ColdStorageOptionsProperty.builder() .enabled(false) .build()) .dedicatedMasterCount(123) .dedicatedMasterEnabled(false) .dedicatedMasterType("dedicatedMasterType") .instanceCount(123) .instanceType("instanceType") .warmCount(123) .warmEnabled(false) .warmType("warmType") .zoneAwarenessConfig(ZoneAwarenessConfigProperty.builder() .availabilityZoneCount(123) .build()) .zoneAwarenessEnabled(false) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDomain.ElasticsearchClusterConfigProperty
static final class
An implementation forCfnDomain.ElasticsearchClusterConfigProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Specifies cold storage options for the domain.default Number
The number of instances to use for the master node.default Object
Indicates whether to use a dedicated master node for the OpenSearch Service domain.default String
The hardware configuration of the computer that hosts the dedicated master node, such asm3.medium.elasticsearch
.default Number
The number of data nodes (instances) to use in the OpenSearch Service domain.default String
The instance type for your data nodes, such asm3.medium.elasticsearch
.default Number
The number of warm nodes in the cluster.default Object
Whether to enable warm storage for the cluster.default String
The instance type for the cluster's warm nodes.default Object
Specifies zone awareness configuration options.default Object
Indicates whether to enable zone awareness for the OpenSearch Service domain.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getColdStorageOptions
Specifies cold storage options for the domain. -
getDedicatedMasterCount
The number of instances to use for the master node.If you specify this property, you must specify true for the DedicatedMasterEnabled property.
-
getDedicatedMasterEnabled
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 .
-
getDedicatedMasterType
The hardware configuration of the computer that hosts the dedicated master node, such asm3.medium.elasticsearch
. If you specify this property, you must specify true for theDedicatedMasterEnabled
property. For valid values, see Supported instance types in Amazon OpenSearch Service . -
getInstanceCount
The number of data nodes (instances) to use in the OpenSearch Service domain. -
getInstanceType
The instance type for your data nodes, such asm3.medium.elasticsearch
. For valid values, see Supported instance types in Amazon OpenSearch Service . -
getWarmCount
The number of warm nodes in the cluster.Required if you enable warm storage.
-
getWarmEnabled
Whether to enable warm storage for the cluster. -
getWarmType
The instance type for the cluster's warm nodes.Required if you enable warm storage.
-
getZoneAwarenessConfig
Specifies zone awareness configuration options.Only use if
ZoneAwarenessEnabled
istrue
. -
getZoneAwarenessEnabled
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 .
-
builder
-