AWS CDK Reference

Appearance

v2.274.0

EbsOptions Struct ​

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

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

Source
aws-opensearchservice/lib/domain.ts
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
const domain = new Domain(this, 'Domain', {
  version: EngineVersion.OPENSEARCH_1_3,
  ebs: {
    volumeSize: 10,
    volumeType: ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3,
  },
  zoneAwareness: {
    enabled: true,
    availabilityZoneCount: 3,
  },
  capacity: {
    multiAzWithStandbyEnabled: true,
    masterNodes: 3,
    dataNodes: 3,
  },
});

Properties ​

enabledbooleanenabledboolenabledBooleanEnabledboolEnabled*bool= true#
Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon OpenSearch Service domain.
iopsnumberiopsint | floatiopsNumberIopsdoubleIops*float64#
The number of I/O operations per second (IOPS) that the volume supports.

Default: iops are not set.

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

throughputnumberthroughputint | floatthroughputNumberThroughputdoubleThroughput*float64#
The throughput (in MiB/s) of the EBS volumes attached to data nodes.

Default: throughput is not set.

This property applies only to the gp3 volume type.

volumeSizenumbervolume_sizeint | floatvolumeSizeNumberVolumeSizedoubleVolumeSize*float64= 10#
The size (in GiB) of the EBS volume for each data node.
notes

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.

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