software.amazon.awscdk.services.opensearchservice

Interface EbsOptions

All Known Implementing Classes:

EbsOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:08.137Z")
public interface 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:

 Domain prodDomain = Domain.Builder.create(this, "Domain")
         .version(EngineVersion.OPENSEARCH_1_0)
         .capacity(CapacityConfig.builder()
                 .masterNodes(5)
                 .dataNodes(20)
                 .build())
         .ebs(EbsOptions.builder()
                 .volumeSize(20)
                 .build())
         .zoneAwareness(ZoneAwarenessConfig.builder()
                 .availabilityZoneCount(3)
                 .build())
         .logging(LoggingOptions.builder()
                 .slowSearchLogEnabled(true)
                 .appLogEnabled(true)
                 .slowIndexLogEnabled(true)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EbsOptions.Builder A builder for EbsOptions
static class	EbsOptions.Jsii$Proxy An implementation for EbsOptions

Method Summary

Modifier and Type	Method and Description
static EbsOptions.Builder	builder()
default java.lang.Boolean	getEnabled() Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon OpenSearch Service domain.
default java.lang.Number	getIops() The number of I/O operations per second (IOPS) that the volume supports.
default java.lang.Number	getVolumeSize() The size (in GiB) of the EBS volume for each data node.
default EbsDeviceVolumeType	getVolumeType() The EBS volume type to use with the Amazon OpenSearch Service domain, such as standard, gp2, io1.

Method Detail

getEnabled

default java.lang.Boolean getEnabled()

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

Default: - true

getIops

default java.lang.Number getIops()

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.

Default: - iops are not set.

getVolumeSize

default java.lang.Number getVolumeSize()

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.

Default: 10

getVolumeType

default EbsDeviceVolumeType getVolumeType()

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

Default: gp2

builder

static EbsOptions.Builder builder()

Returns:

a EbsOptions.Builder of EbsOptions