Package software.amazon.awscdk.services.opensearchservice

Interface CfnDomain.ClusterConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.ClusterConfigProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.ClusterConfigProperty
extends software.amazon.jsii.JsiiSerializable

The cluster configuration for the OpenSearch Service domain.

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()
         .coldStorageOptions(ColdStorageOptionsProperty.builder()
                 .enabled(false)
                 .build())
         .dedicatedMasterCount(123)
         .dedicatedMasterEnabled(false)
         .dedicatedMasterType("dedicatedMasterType")
         .instanceCount(123)
         .instanceType("instanceType")
         .multiAzWithStandbyEnabled(false)
         .warmCount(123)
         .warmEnabled(false)
         .warmType("warmType")
         .zoneAwarenessConfig(ZoneAwarenessConfigProperty.builder()
                 .availabilityZoneCount(123)
                 .build())
         .zoneAwarenessEnabled(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomain.ClusterConfigProperty.Builder	A builder for CfnDomain.ClusterConfigProperty
static final class	CfnDomain.ClusterConfigProperty.Jsii$Proxy	An implementation for CfnDomain.ClusterConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomain.ClusterConfigProperty.Builder	builder()
default Object	getColdStorageOptions()	Container for cold storage configuration options.
default Number	getDedicatedMasterCount()	The number of instances to use for the master node.
default Object	getDedicatedMasterEnabled()	Indicates whether to use a dedicated master node for the OpenSearch Service domain.
default String	getDedicatedMasterType()	The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search .
default Number	getInstanceCount()	The number of data nodes (instances) to use in the OpenSearch Service domain.
default String	getInstanceType()	The instance type for your data nodes, such as m3.medium.search .
default Object	getMultiAzWithStandbyEnabled()	Indicates whether Multi-AZ with Standby deployment option is enabled.
default Number	getWarmCount()	The number of warm nodes in the cluster.
default Object	getWarmEnabled()	Whether to enable UltraWarm storage for the cluster.
default String	getWarmType()	The instance type for the cluster's warm nodes.
default Object	getZoneAwarenessConfig()	Specifies zone awareness configuration options.
default Object	getZoneAwarenessEnabled()	Indicates whether to enable zone awareness for the OpenSearch Service domain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColdStorageOptions

@Stability(Stable)
@Nullable
default Object getColdStorageOptions()

Container for cold storage configuration options.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-coldstorageoptions

getDedicatedMasterCount

@Stability(Stable)
@Nullable
default Number getDedicatedMasterCount()

The number of instances to use for the master node.

If you specify this property, you must specify true for the DedicatedMasterEnabled property.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-dedicatedmastercount

getDedicatedMasterEnabled

@Stability(Stable)
@Nullable
default Object 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-dedicatedmasterenabled

getDedicatedMasterType

@Stability(Stable)
@Nullable
default String getDedicatedMasterType()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-dedicatedmastertype

getInstanceCount

@Stability(Stable)
@Nullable
default Number getInstanceCount()

The number of data nodes (instances) to use in the OpenSearch Service domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-instancecount

getInstanceType

@Stability(Stable)
@Nullable
default String getInstanceType()

The instance type for your data nodes, such as m3.medium.search . For valid values, see Supported instance types in Amazon OpenSearch Service .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-instancetype

getMultiAzWithStandbyEnabled

@Stability(Stable)
@Nullable
default Object getMultiAzWithStandbyEnabled()

Indicates whether Multi-AZ with Standby deployment option is enabled.

For more information, see Multi-AZ with Standby .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-multiazwithstandbyenabled

getWarmCount

@Stability(Stable)
@Nullable
default Number getWarmCount()

The number of warm nodes in the cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-warmcount

getWarmEnabled

@Stability(Stable)
@Nullable
default Object getWarmEnabled()

Whether to enable UltraWarm storage for the cluster.

See UltraWarm storage for Amazon OpenSearch Service .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-warmenabled

getWarmType

@Stability(Stable)
@Nullable
default String getWarmType()

The instance type for the cluster's warm nodes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-warmtype

getZoneAwarenessConfig

@Stability(Stable)
@Nullable
default Object getZoneAwarenessConfig()

Specifies zone awareness configuration options.

Only use if ZoneAwarenessEnabled is true .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-zoneawarenessconfig

getZoneAwarenessEnabled

@Stability(Stable)
@Nullable
default Object 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-zoneawarenessenabled

builder

@Stability(Stable)
static CfnDomain.ClusterConfigProperty.Builder builder()

Returns:

a CfnDomain.ClusterConfigProperty.Builder of CfnDomain.ClusterConfigProperty