software.amazon.awscdk.services.opensearchservice

Interface ZoneAwarenessConfig

All Known Implementing Classes:

ZoneAwarenessConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.860Z")
public interface ZoneAwarenessConfig

Specifies zone awareness configuration options.

Example:

 Domain prodDomain = Domain.Builder.create(this, "Domain")
         .version(EngineVersion.OPENSEARCH_1_0)
         .capacity(CapacityConfig.builder()
                 .masterNodes(5)
                 .dataNodes(20)
                 .build())
         .ebs(EbsOptions.builder()
                 .volumeSize(20)
                 .build())
         .zoneAwareness(ZoneAwarenessConfig.builder()
                 .availabilityZoneCount(3)
                 .build())
         .logging(LoggingOptions.builder()
                 .slowSearchLogEnabled(true)
                 .appLogEnabled(true)
                 .slowIndexLogEnabled(true)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getAvailabilityZoneCount

default java.lang.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

default java.lang.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] (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html) in the Amazon OpenSearch Service Developer Guide.

Default: - false

builder

static ZoneAwarenessConfig.Builder builder()

Returns:

a ZoneAwarenessConfig.Builder of ZoneAwarenessConfig