Class ZoneAwarenessConfig

Specifies zone awareness configuration options.

Inheritance

object

ZoneAwarenessConfig

Implements

IZoneAwarenessConfig

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.OpenSearchService

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ZoneAwarenessConfig : IZoneAwarenessConfig

Syntax (vb)

Public Class ZoneAwarenessConfig Implements IZoneAwarenessConfig

Remarks

ExampleMetadata: infused

Examples

var domain = new Domain(this, "Domain", new DomainProps {
                Version = EngineVersion.OPENSEARCH_1_3,
                Ebs = new EbsOptions {
                    VolumeSize = 10,
                    VolumeType = EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3
                },
                ZoneAwareness = new ZoneAwarenessConfig {
                    Enabled = true,
                    AvailabilityZoneCount = 3
                },
                Capacity = new CapacityConfig {
                    MultiAzWithStandbyEnabled = true,
                    MasterNodes = 3,
                    DataNodes = 3
                }
            });

Synopsis

Constructors

ZoneAwarenessConfig()

Specifies zone awareness configuration options.

Properties

AvailabilityZoneCount	If you enabled multiple Availability Zones (AZs), the number of AZs that you want the domain to use.
Enabled	Indicates whether to enable zone awareness for the Amazon OpenSearch Service domain.

Constructors

ZoneAwarenessConfig()

Specifies zone awareness configuration options.

public ZoneAwarenessConfig()

Remarks

ExampleMetadata: infused

Examples

var domain = new Domain(this, "Domain", new DomainProps {
                Version = EngineVersion.OPENSEARCH_1_3,
                Ebs = new EbsOptions {
                    VolumeSize = 10,
                    VolumeType = EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3
                },
                ZoneAwareness = new ZoneAwarenessConfig {
                    Enabled = true,
                    AvailabilityZoneCount = 3
                },
                Capacity = new CapacityConfig {
                    MultiAzWithStandbyEnabled = true,
                    MasterNodes = 3,
                    DataNodes = 3
                }
            });

Properties

AvailabilityZoneCount

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

public double? AvailabilityZoneCount { get; set; }

Property Value

double?

Remarks

Valid values are 2 and 3.

Default: - 2 if zone awareness is enabled.

Enabled

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

public bool? Enabled { get; set; }

Property Value

bool?

Remarks

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

Implements

IZoneAwarenessConfig