software.amazon.awscdk.services.elasticsearch

Interface EbsOptions

All Known Implementing Classes:

EbsOptions.Jsii$Proxy

Deprecated.

use opensearchservice module instead

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:32.972Z")
 @Deprecated
public interface EbsOptions

(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 java.lang.Boolean	getEnabled() Deprecated. use opensearchservice module instead
default java.lang.Number	getIops() Deprecated. use opensearchservice module instead
default java.lang.Number	getVolumeSize() Deprecated. use opensearchservice module instead
default EbsDeviceVolumeType	getVolumeType() Deprecated. use opensearchservice module instead

Method Detail

getEnabled

@Deprecated
default java.lang.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

@Deprecated
default java.lang.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

@Deprecated
default java.lang.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

@Deprecated
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

@Deprecated
static EbsOptions.Builder builder()

Deprecated.

Returns:

a EbsOptions.Builder of EbsOptions