Package software.amazon.awscdk.services.opensearchservice

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 .

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.opensearchservice.*;
 EBSOptionsProperty eBSOptionsProperty = EBSOptionsProperty.builder()
         .ebsEnabled(false)
         .iops(123)
         .throughput(123)
         .volumeSize(123)
         .volumeType("volumeType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDomain.EBSOptionsProperty.Builder	builder()
default Object	getEbsEnabled()	Specifies whether Amazon EBS volumes are attached to data nodes in the OpenSearch Service domain.
default Number	getIops()	The number of I/O operations per second (IOPS) that the volume supports.
default Number	getThroughput()	The throughput (in MiB/s) of the EBS volumes attached to data nodes.
default Number	getVolumeSize()	The size (in GiB) of the EBS volume for each data node.
default String	getVolumeType()	The EBS volume type to use with the OpenSearch Service domain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEbsEnabled

@Stability(Stable)
@Nullable
default Object getEbsEnabled()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-ebsenabled

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-iops

getThroughput

@Stability(Stable)
@Nullable
default Number getThroughput()

The throughput (in MiB/s) of the EBS volumes attached to data nodes.

Applies only to the gp3 volume type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-throughput

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-volumesize

getVolumeType

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

The EBS volume type to use with the OpenSearch Service domain.

If you choose gp3 , you must also specify values for Iops and Throughput . For more information about each type, see Amazon EBS volume types in the Amazon EC2 User Guide for Linux Instances .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-volumetype

builder

@Stability(Stable)
static CfnDomain.EBSOptionsProperty.Builder builder()

Returns:

a CfnDomain.EBSOptionsProperty.Builder of CfnDomain.EBSOptionsProperty