Class EbsOptions

(deprecated) The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon ES 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.Elasticsearch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class EbsOptions : IEbsOptions

Syntax (vb)

Public Class EbsOptions Implements IEbsOptions

Remarks

For more information, see [Configuring EBS-based Storage] (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) in the Amazon Elasticsearch Service Developer Guide.

Stability: Deprecated

ExampleMetadata: infused

Examples

var prodDomain = new Domain(this, "Domain", new DomainProps {
                 Version = ElasticsearchVersion.V7_1,
                 Capacity = new CapacityConfig {
                     MasterNodes = 5,
                     DataNodes = 20
                 },
                 Ebs = new EbsOptions {
                     VolumeSize = 20
                 },
                 ZoneAwareness = new ZoneAwarenessConfig {
                     AvailabilityZoneCount = 3
                 },
                 Logging = new LoggingOptions {
                     SlowSearchLogEnabled = true,
                     AppLogEnabled = true,
                     SlowIndexLogEnabled = true
                 }
             });

Synopsis

Constructors

EbsOptions()

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

Properties

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

Constructors

EbsOptions()

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

public EbsOptions()

Remarks

For more information, see [Configuring EBS-based Storage] (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) in the Amazon Elasticsearch Service Developer Guide.

Stability: Deprecated

ExampleMetadata: infused

Examples

var prodDomain = new Domain(this, "Domain", new DomainProps {
                 Version = ElasticsearchVersion.V7_1,
                 Capacity = new CapacityConfig {
                     MasterNodes = 5,
                     DataNodes = 20
                 },
                 Ebs = new EbsOptions {
                     VolumeSize = 20
                 },
                 ZoneAwareness = new ZoneAwarenessConfig {
                     AvailabilityZoneCount = 3
                 },
                 Logging = new LoggingOptions {
                     SlowSearchLogEnabled = true,
                     AppLogEnabled = true,
                     SlowIndexLogEnabled = true
                 }
             });

Properties

Enabled

(deprecated) Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon ES domain.

[Obsolete("use opensearchservice module instead")]
public bool? Enabled { get; set; }

Property Value

bool?

Remarks

Default: - true

Stability: Deprecated

Iops

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

[Obsolete("use opensearchservice module instead")]
public double? Iops { get; set; }

Property Value

double?

Remarks

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

Default: - iops are not set.

Stability: Deprecated

VolumeSize

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

[Obsolete("use opensearchservice module instead")]
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 more information, see [Configuring EBS-based Storage] (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) in the Amazon Elasticsearch Service Developer Guide.

Default: 10

Stability: Deprecated

VolumeType

(deprecated) The EBS volume type to use with the Amazon ES domain, such as standard, gp2, io1.

[Obsolete("use opensearchservice module instead")]
public EbsDeviceVolumeType? VolumeType { get; set; }

Property Value

EbsDeviceVolumeType?

Remarks

For more information, see[Configuring EBS-based Storage] (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) in the Amazon Elasticsearch Service Developer Guide.

Default: gp2

Stability: Deprecated

Implements

IEbsOptions