software.amazon.awscdk.services.opensearchservice

Class EbsOptions.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchservice.EbsOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EbsOptions>

Enclosing interface:

EbsOptions

@Stability(value=Stable)
public static final class EbsOptions.Builder
extends Object
implements software.amazon.jsii.Builder<EbsOptions>

A builder for EbsOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
EbsOptions	build() Builds the configured instance.
EbsOptions.Builder	enabled(Boolean enabled) Sets the value of EbsOptions.getEnabled()
EbsOptions.Builder	iops(Number iops) Sets the value of EbsOptions.getIops()
EbsOptions.Builder	volumeSize(Number volumeSize) Sets the value of EbsOptions.getVolumeSize()
EbsOptions.Builder	volumeType(EbsDeviceVolumeType volumeType) Sets the value of EbsOptions.getVolumeType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

enabled

@Stability(value=Stable)
public EbsOptions.Builder enabled(Boolean enabled)

Sets the value of EbsOptions.getEnabled()

Parameters:

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

Returns:

this

iops

@Stability(value=Stable)
public EbsOptions.Builder iops(Number iops)

Sets the value of EbsOptions.getIops()

Parameters:

iops - 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.

Returns:

this

volumeSize

@Stability(value=Stable)
public EbsOptions.Builder volumeSize(Number volumeSize)

Sets the value of EbsOptions.getVolumeSize()

Parameters:

volumeSize - 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.

Returns:

this

volumeType

@Stability(value=Stable)
public EbsOptions.Builder volumeType(EbsDeviceVolumeType volumeType)

Sets the value of EbsOptions.getVolumeType()

Parameters:

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

Returns:

this

build

@Stability(value=Stable)
public EbsOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<EbsOptions>

Returns:

a new instance of EbsOptions

Throws:

NullPointerException - if any required attribute was not provided