EBSOptions (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.opensearch.model.EBSOptions

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EBSOptions
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

EBSOptions()

Constructors
Constructor and Description
`EBSOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EBSOptions`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getEBSEnabled()` Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
`Integer`	`getIops()` Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes.
`Integer`	`getThroughput()` Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes.
`Integer`	`getVolumeSize()` Specifies the size (in GiB) of EBS volumes attached to data nodes.
`String`	`getVolumeType()` Specifies the type of EBS volumes attached to data nodes.
`int`	`hashCode()`
`Boolean`	`isEBSEnabled()` Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEBSEnabled(Boolean eBSEnabled)` Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
`void`	`setIops(Integer iops)` Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes.
`void`	`setThroughput(Integer throughput)` Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes.
`void`	`setVolumeSize(Integer volumeSize)` Specifies the size (in GiB) of EBS volumes attached to data nodes.
`void`	`setVolumeType(String volumeType)` Specifies the type of EBS volumes attached to data nodes.
`String`	`toString()` Returns a string representation of this object.
`EBSOptions`	`withEBSEnabled(Boolean eBSEnabled)` Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
`EBSOptions`	`withIops(Integer iops)` Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes.
`EBSOptions`	`withThroughput(Integer throughput)` Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes.
`EBSOptions`	`withVolumeSize(Integer volumeSize)` Specifies the size (in GiB) of EBS volumes attached to data nodes.
`EBSOptions`	`withVolumeType(String volumeType)` Specifies the type of EBS volumes attached to data nodes.
`EBSOptions`	`withVolumeType(VolumeType volumeType)` Specifies the type of EBS volumes attached to data nodes.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EBSOptions
```
public EBSOptions()
```
- Method Detail
  - setEBSEnabled
```
public void setEBSEnabled(Boolean eBSEnabled)
```
    Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
    
    Parameters:
    
    eBSEnabled - Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
  - getEBSEnabled
```
public Boolean getEBSEnabled()
```
    Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
    
    Returns:
    
    Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
  - withEBSEnabled
```
public EBSOptions withEBSEnabled(Boolean eBSEnabled)
```
    Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
    
    Parameters:
    
    eBSEnabled - Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEBSEnabled
```
public Boolean isEBSEnabled()
```
    Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
    
    Returns:
    
    Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
  - setVolumeType
```
public void setVolumeType(String volumeType)
```
    Specifies the type of EBS volumes attached to data nodes.
    
    Parameters:
    
    volumeType - Specifies the type of EBS volumes attached to data nodes.
    
    See Also:
    
    VolumeType
  - getVolumeType
```
public String getVolumeType()
```
    Specifies the type of EBS volumes attached to data nodes.
    
    Returns:
    
    Specifies the type of EBS volumes attached to data nodes.
    
    See Also:
    
    VolumeType
  - withVolumeType
```
public EBSOptions withVolumeType(String volumeType)
```
    Specifies the type of EBS volumes attached to data nodes.
    
    Parameters:
    
    volumeType - Specifies the type of EBS volumes attached to data nodes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeType
  - withVolumeType
```
public EBSOptions withVolumeType(VolumeType volumeType)
```
    Specifies the type of EBS volumes attached to data nodes.
    
    Parameters:
    
    volumeType - Specifies the type of EBS volumes attached to data nodes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeType
  - setVolumeSize
```
public void setVolumeSize(Integer volumeSize)
```
    Specifies the size (in GiB) of EBS volumes attached to data nodes.
    
    Parameters:
    
    volumeSize - Specifies the size (in GiB) of EBS volumes attached to data nodes.
  - getVolumeSize
```
public Integer getVolumeSize()
```
    Specifies the size (in GiB) of EBS volumes attached to data nodes.
    
    Returns:
    
    Specifies the size (in GiB) of EBS volumes attached to data nodes.
  - withVolumeSize
```
public EBSOptions withVolumeSize(Integer volumeSize)
```
    Specifies the size (in GiB) of EBS volumes attached to data nodes.
    
    Parameters:
    
    volumeSize - Specifies the size (in GiB) of EBS volumes attached to data nodes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIops
```
public void setIops(Integer iops)
```
    Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.
    
    Parameters:
    
    iops - Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.
  - getIops
```
public Integer getIops()
```
    Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.
    
    Returns:
    
    Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.
  - withIops
```
public EBSOptions withIops(Integer iops)
```
    Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.
    
    Parameters:
    
    iops - Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThroughput
```
public void setThroughput(Integer throughput)
```
    Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
    
    Parameters:
    
    throughput - Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
  - getThroughput
```
public Integer getThroughput()
```
    Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
    
    Returns:
    
    Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
  - withThroughput
```
public EBSOptions withThroughput(Integer throughput)
```
    Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
    
    Parameters:
    
    throughput - Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EBSOptions clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

Class EBSOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EBSOptions

Method Detail

setEBSEnabled

getEBSEnabled

withEBSEnabled

isEBSEnabled

setVolumeType

getVolumeType

withVolumeType

withVolumeType

setVolumeSize

getVolumeSize

withVolumeSize

setIops

getIops

withIops

setThroughput

getThroughput

withThroughput

toString

equals

hashCode

clone

marshall