aws-cdk-lib.aws_opensearchservice.EbsOptions

interface EbsOptions

LanguageType name
.NETAmazon.CDK.AWS.OpenSearchService.EbsOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsopensearchservice#EbsOptions
Javasoftware.amazon.awscdk.services.opensearchservice.EbsOptions
Pythonaws_cdk.aws_opensearchservice.EbsOptions
TypeScript (source)aws-cdk-lib » aws_opensearchservice » EbsOptions

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] (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html) in the Amazon Elastic Compute Cloud Developer Guide.

Example

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

Properties

NameTypeDescription
enabled?booleanSpecifies whether Amazon EBS volumes are attached to data nodes in the Amazon OpenSearch Service domain.
iops?numberThe number of I/O operations per second (IOPS) that the volume supports.
volumeSize?numberThe size (in GiB) of the EBS volume for each data node.
volumeType?EbsDeviceVolumeTypeThe EBS volume type to use with the Amazon OpenSearch Service domain, such as standard, gp2, io1.

enabled?

Type: boolean (optional, default: true)

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


iops?

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?

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 valid values, see [EBS volume size limits] (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the Amazon OpenSearch Service Developer Guide.


volumeType?

Type: EbsDeviceVolumeType (optional, default: gp2)

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