Package software.amazon.awscdk.services.opensearchservice

Interface ZoneAwarenessConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ZoneAwarenessConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:05.072Z")
@Stability(Stable)
public interface ZoneAwarenessConfig
extends software.amazon.jsii.JsiiSerializable

Specifies zone awareness configuration options.

Example:

 Domain domain = Domain.Builder.create(this, "Domain")
         .version(EngineVersion.OPENSEARCH_1_3)
         .ebs(EbsOptions.builder()
                 .volumeSize(10)
                 .volumeType(EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3)
                 .build())
         .zoneAwareness(ZoneAwarenessConfig.builder()
                 .enabled(true)
                 .availabilityZoneCount(3)
                 .build())
         .capacity(CapacityConfig.builder()
                 .multiAzWithStandbyEnabled(true)
                 .masterNodes(3)
                 .dataNodes(3)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ZoneAwarenessConfig.Builder	builder()
default Number	getAvailabilityZoneCount()	If you enabled multiple Availability Zones (AZs), the number of AZs that you want the domain to use.
default Boolean	getEnabled()	Indicates whether to enable zone awareness for the Amazon OpenSearch Service domain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAvailabilityZoneCount

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

If you enabled multiple Availability Zones (AZs), the number of AZs that you want the domain to use.

Valid values are 2 and 3.

Default: - 2 if zone awareness is enabled.

getEnabled

@Stability(Stable)
@Nullable
default Boolean getEnabled()

Indicates whether to enable zone awareness for the Amazon OpenSearch Service domain.

When you enable zone awareness, Amazon 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 the Amazon OpenSearch Service Developer Guide.

Default: - false

builder

@Stability(Stable)
static ZoneAwarenessConfig.Builder builder()

Returns:

a ZoneAwarenessConfig.Builder of ZoneAwarenessConfig