public static interface CfnDomain.ClusterConfigProperty
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 .
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.opensearchservice.*; ClusterConfigProperty clusterConfigProperty = ClusterConfigProperty.builder() .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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnDomain.ClusterConfigProperty.Builder
A builder for
CfnDomain.ClusterConfigProperty |
static class |
CfnDomain.ClusterConfigProperty.Jsii$Proxy
An implementation for
CfnDomain.ClusterConfigProperty |
Modifier and Type | Method and Description |
---|---|
static CfnDomain.ClusterConfigProperty.Builder |
builder() |
default java.lang.Number |
getDedicatedMasterCount()
The number of instances to use for the master node.
|
default java.lang.Object |
getDedicatedMasterEnabled()
Indicates whether to use a dedicated master node for the OpenSearch Service domain.
|
default java.lang.String |
getDedicatedMasterType()
The hardware configuration of the computer that hosts the dedicated master node, such as `m3.medium.search` .
|
default java.lang.Number |
getInstanceCount()
The number of data nodes (instances) to use in the OpenSearch Service domain.
|
default java.lang.String |
getInstanceType()
The instance type for your data nodes, such as `m3.medium.search` .
|
default java.lang.Number |
getWarmCount()
The number of warm nodes in the cluster.
|
default java.lang.Object |
getWarmEnabled()
Whether to enable UltraWarm storage for the cluster.
|
default java.lang.String |
getWarmType()
The instance type for the cluster's warm nodes.
|
default java.lang.Object |
getZoneAwarenessConfig()
Specifies zone awareness configuration options.
|
default java.lang.Object |
getZoneAwarenessEnabled()
Indicates whether to enable zone awareness for the OpenSearch Service domain.
|
default java.lang.Number getDedicatedMasterCount()
If you specify this property, you must specify true
for the DedicatedMasterEnabled
property.
default java.lang.Object getDedicatedMasterEnabled()
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 .
default java.lang.String getDedicatedMasterType()
default java.lang.Number getInstanceCount()
default java.lang.String getInstanceType()
default java.lang.Number getWarmCount()
default java.lang.Object getWarmEnabled()
default java.lang.String getWarmType()
default java.lang.Object getZoneAwarenessConfig()
Only use if ZoneAwarenessEnabled
is true
.
default java.lang.Object getZoneAwarenessEnabled()
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 .
static CfnDomain.ClusterConfigProperty.Builder builder()