Class EbsOptions

The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon OpenSearch Service domain.

Inheritance

object

EbsOptions

Implements

IEbsOptions

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 EbsOptions : IEbsOptions

Syntax (vb)

Public Class EbsOptions Implements IEbsOptions

Remarks

For more information, see Amazon EBS in the Amazon Elastic Compute Cloud Developer Guide.

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

EbsOptions()

The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon OpenSearch Service domain.

Properties

Enabled	Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon OpenSearch Service domain.
Iops	The number of I/O operations per second (IOPS) that the volume supports.
Throughput	The throughput (in MiB/s) of the EBS volumes attached to data nodes.
VolumeSize	The size (in GiB) of the EBS volume for each data node.
VolumeType	The EBS volume type to use with the Amazon OpenSearch Service domain, such as standard, gp2, io1.

Constructors

EbsOptions()

The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon OpenSearch Service domain.

public EbsOptions()

Remarks

For more information, see Amazon EBS in the Amazon Elastic Compute Cloud Developer Guide.

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

Enabled

Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon OpenSearch Service domain.

public bool? Enabled { get; set; }

Property Value

bool?

Remarks

Default: - true

Iops

The number of I/O operations per second (IOPS) that the volume supports.

public double? Iops { get; set; }

Property Value

double?

Remarks

This property applies only to the gp3 and Provisioned IOPS (SSD) EBS volume type.

Default: - iops are not set.

Throughput

The throughput (in MiB/s) of the EBS volumes attached to data nodes.

public double? Throughput { get; set; }

Property Value

double?

Remarks

This property applies only to the gp3 volume type.

Default: - throughput is not set.

VolumeSize

The size (in GiB) of the EBS volume for each data node.

public double? VolumeSize { get; set; }

Property Value

double?

Remarks

The minimum and maximum size of an EBS volume depends on the EBS volume type and the instance type to which it is attached. For valid values, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide.

Default: 10

VolumeType

The EBS volume type to use with the Amazon OpenSearch Service domain, such as standard, gp2, io1.

public EbsDeviceVolumeType? VolumeType { get; set; }

Property Value

EbsDeviceVolumeType?

Remarks

Default: gp2

Implements

IEbsOptions