Package software.amazon.awscdk.services.opensearchservice

Interface EbsOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EbsOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:44.587Z")
@Stability(Stable)
public interface EbsOptions
extends software.amazon.jsii.JsiiSerializable

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	Description
static final class	EbsOptions.Builder	A builder for EbsOptions
static final class	EbsOptions.Jsii$Proxy	An implementation for EbsOptions

Method Summary

Modifier and Type	Method	Description
static EbsOptions.Builder	builder()
default Boolean	getEnabled()	Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon OpenSearch Service domain.
default Number	getIops()	The number of I/O operations per second (IOPS) that the volume supports.
default 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@Nullable
default Boolean getEnabled()

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

Default: - true

getIops

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
@Nullable
default EbsDeviceVolumeType getVolumeType()

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

Default: gp2

builder

@Stability(Stable)
static EbsOptions.Builder builder()

Returns:

a EbsOptions.Builder of EbsOptions