software.amazon.awscdk.services.elasticsearch

Interface EbsOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EbsOptions.Jsii$Proxy

Deprecated.

use opensearchservice module instead

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-10-06T13:25:06.391Z")
 @Stability(value=Deprecated)
 @Deprecated
public interface EbsOptions
extends software.amazon.jsii.JsiiSerializable

(deprecated) 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:

 Domain prodDomain = Domain.Builder.create(this, "Domain")
         .version(ElasticsearchVersion.V7_1)
         .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 Deprecated.
static class	EbsOptions.Jsii$Proxy Deprecated.

Method Summary

Modifier and Type	Method and Description
static EbsOptions.Builder	builder() Deprecated.
default Boolean	getEnabled() Deprecated. use opensearchservice module instead
default Number	getIops() Deprecated. use opensearchservice module instead
default Number	getVolumeSize() Deprecated. use opensearchservice module instead
default EbsDeviceVolumeType	getVolumeType() Deprecated. use opensearchservice module instead

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEnabled

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Boolean getEnabled()

Deprecated. use opensearchservice module instead

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

Default: - true

getIops

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Number getIops()

Deprecated. use opensearchservice module instead

(deprecated) 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(value=Deprecated)
 @Deprecated
 @Nullable
default Number getVolumeSize()

Deprecated. use opensearchservice module instead

(deprecated) 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.

Default: 10

getVolumeType

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default EbsDeviceVolumeType getVolumeType()

Deprecated. use opensearchservice module instead

(deprecated) 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.

Default: gp2

builder

@Stability(value=Deprecated)
 @Deprecated
static EbsOptions.Builder builder()

Deprecated.

Returns:

a EbsOptions.Builder of EbsOptions