Package software.amazon.awscdk.services.opensearchservice

Class CfnDomain.EBSOptionsProperty.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchservice.CfnDomain.EBSOptionsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomain.EBSOptionsProperty>

Enclosing interface:

CfnDomain.EBSOptionsProperty

@Stability(Stable)
public static final class CfnDomain.EBSOptionsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDomain.EBSOptionsProperty>

A builder for CfnDomain.EBSOptionsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDomain.EBSOptionsProperty	build()	Builds the configured instance.
CfnDomain.EBSOptionsProperty.Builder	ebsEnabled(Boolean ebsEnabled)	Sets the value of CfnDomain.EBSOptionsProperty.getEbsEnabled()
CfnDomain.EBSOptionsProperty.Builder	ebsEnabled(IResolvable ebsEnabled)	Sets the value of CfnDomain.EBSOptionsProperty.getEbsEnabled()
CfnDomain.EBSOptionsProperty.Builder	iops(Number iops)	Sets the value of CfnDomain.EBSOptionsProperty.getIops()
CfnDomain.EBSOptionsProperty.Builder	throughput(Number throughput)	Sets the value of CfnDomain.EBSOptionsProperty.getThroughput()
CfnDomain.EBSOptionsProperty.Builder	volumeSize(Number volumeSize)	Sets the value of CfnDomain.EBSOptionsProperty.getVolumeSize()
CfnDomain.EBSOptionsProperty.Builder	volumeType(String volumeType)	Sets the value of CfnDomain.EBSOptionsProperty.getVolumeType()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

ebsEnabled

@Stability(Stable)
public CfnDomain.EBSOptionsProperty.Builder ebsEnabled(Boolean ebsEnabled)

Sets the value of CfnDomain.EBSOptionsProperty.getEbsEnabled()

Parameters:

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

Returns:

this

ebsEnabled

@Stability(Stable)
public CfnDomain.EBSOptionsProperty.Builder ebsEnabled(IResolvable ebsEnabled)

Sets the value of CfnDomain.EBSOptionsProperty.getEbsEnabled()

Parameters:

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

Returns:

this

iops

@Stability(Stable)
public CfnDomain.EBSOptionsProperty.Builder iops(Number iops)

Sets the value of CfnDomain.EBSOptionsProperty.getIops()

Parameters:

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

Returns:

this

throughput

@Stability(Stable)
public CfnDomain.EBSOptionsProperty.Builder throughput(Number throughput)

Sets the value of CfnDomain.EBSOptionsProperty.getThroughput()

Parameters:

throughput - The throughput (in MiB/s) of the EBS volumes attached to data nodes. Applies only to the gp3 volume type.

Returns:

this

volumeSize

@Stability(Stable)
public CfnDomain.EBSOptionsProperty.Builder volumeSize(Number volumeSize)

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

Returns:

this

volumeType

@Stability(Stable)
public CfnDomain.EBSOptionsProperty.Builder volumeType(String volumeType)

Sets the value of CfnDomain.EBSOptionsProperty.getVolumeType()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnDomain.EBSOptionsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDomain.EBSOptionsProperty>

Returns:

a new instance of CfnDomain.EBSOptionsProperty

Throws:

NullPointerException - if any required attribute was not provided