Interface CfnDomain.ClusterConfigProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnDomain.ClusterConfigProperty extends
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 .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 ClusterConfigProperty clusterConfigProperty = ClusterConfigProperty.builder()
  • Method Details

    • 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.

    • 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 .

    • getDedicatedMasterType

      @Stability(Stable) @Nullable default String getDedicatedMasterType()
      The hardware configuration of the computer that hosts the dedicated master node, such as . If you specify this property, you must specify true for the DedicatedMasterEnabled property. For valid values, see Supported instance types in Amazon OpenSearch Service .
    • getInstanceCount

      @Stability(Stable) @Nullable default Number getInstanceCount()
      The number of data nodes (instances) to use in the OpenSearch Service domain.
    • getInstanceType

      @Stability(Stable) @Nullable default String getInstanceType()
      The instance type for your data nodes, such as . For valid values, see Supported instance types in Amazon OpenSearch Service .
    • 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 .

    • getWarmCount

      @Stability(Stable) @Nullable default Number getWarmCount()
      The number of warm nodes in the cluster.
    • getWarmEnabled

      @Stability(Stable) @Nullable default Object getWarmEnabled()
      Whether to enable UltraWarm storage for the cluster.

      See UltraWarm storage for Amazon OpenSearch Service .

    • getWarmType

      @Stability(Stable) @Nullable default String getWarmType()
      The instance type for the cluster's warm nodes.
    • getZoneAwarenessConfig

      @Stability(Stable) @Nullable default Object getZoneAwarenessConfig()
      Specifies zone awareness configuration options.

      Only use if ZoneAwarenessEnabled is true .

    • 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 .

    • builder

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