interface EbsOptions ⚠️

Language	Type name
.NET	`Amazon.CDK.AWS.Elasticsearch.EbsOptions`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awselasticsearch#EbsOptions`
Java	`software.amazon.awscdk.services.elasticsearch.EbsOptions`
Python	`aws_cdk.aws_elasticsearch.EbsOptions`
TypeScript (source)	`aws-cdk-lib` » `aws_elasticsearch` » `EbsOptions`

⚠️ Deprecated: use opensearchservice module instead

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

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.

Example

const prodDomain = new es.Domain(this, 'Domain', {
  version: es.ElasticsearchVersion.V7_1,
  capacity: {
    masterNodes: 5,
    dataNodes: 20,
  },
  ebs: {
    volumeSize: 20,
  },
  zoneAwareness: {
    availabilityZoneCount: 3,
  },
  logging: {
    slowSearchLogEnabled: true,
    appLogEnabled: true,
    slowIndexLogEnabled: true,
  },
});

Properties

Name	Type	Description
enabled?⚠️	`boolean`	Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon ES domain.
iops?⚠️	`number`	The number of I/O operations per second (IOPS) that the volume supports.
volumeSize?⚠️	`number`	The size (in GiB) of the EBS volume for each data node.
volumeType?⚠️	`EbsDeviceVolumeType`	The EBS volume type to use with the Amazon ES domain, such as standard, gp2, io1.

enabled?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: boolean (optional, default: true)

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

iops?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: number (optional, default: iops are not set.)

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

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

volumeSize?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: number (optional, default: 10)

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

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.

volumeType?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: EbsDeviceVolumeType (optional, default: gp2)

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

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.