Package software.amazon.awscdk.services.elasticsearch

Interface CfnDomain.EBSOptionsProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDomain.EBSOptionsProperty.Jsii$Proxy
Enclosing class:
CfnDomain
@Stability(Stable) public static interface CfnDomain.EBSOptionsProperty extends software.amazon.jsii.JsiiSerializable
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.

For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see New resource types in the Amazon OpenSearch Service Developer Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticsearch.*;
 EBSOptionsProperty eBSOptionsProperty = EBSOptionsProperty.builder()
         .ebsEnabled(false)
         .iops(123)
         .volumeSize(123)
         .volumeType("volumeType")
         .build();

  • Method Details

    • getEbsEnabled

      @Stability(Stable) @Nullable default Object getEbsEnabled()
      Specifies whether Amazon EBS volumes are attached to data nodes in the OpenSearch Service domain.

    • 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 provisioned IOPS EBS volume types.

    • 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 more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .

    • getVolumeType

      @Stability(Stable) @Nullable default String getVolumeType()
      The EBS volume type to use with the OpenSearch Service domain, such as standard, gp2, or io1.

      For more information about each type, see Amazon EBS volume types in the Amazon EC2 User Guide for Linux Instances .

    • builder

      @Stability(Stable) static CfnDomain.EBSOptionsProperty.Builder builder()
      Returns:
      a CfnDomain.EBSOptionsProperty.Builder of CfnDomain.EBSOptionsProperty