EBSOptions (AWS Java SDK for Amazon OpenSearch 1.12.336 API)

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
```
Options to enable, disable, and specify the properties of EBS storage volumes.

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()` Whether EBS-based storage is enabled.
`Integer`	`getIops()` The IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
`Integer`	`getThroughput()` The Throughput for GP3 EBS volume (SSD).
`Integer`	`getVolumeSize()` Integer to specify the size of an EBS volume.
`String`	`getVolumeType()` The volume type for EBS-based storage.
`int`	`hashCode()`
`Boolean`	`isEBSEnabled()` Whether EBS-based storage is enabled.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setEBSEnabled(Boolean eBSEnabled)` Whether EBS-based storage is enabled.
`void`	`setIops(Integer iops)` The IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
`void`	`setThroughput(Integer throughput)` The Throughput for GP3 EBS volume (SSD).
`void`	`setVolumeSize(Integer volumeSize)` Integer to specify the size of an EBS volume.
`void`	`setVolumeType(String volumeType)` The volume type for EBS-based storage.
`String`	`toString()` Returns a string representation of this object.
`EBSOptions`	`withEBSEnabled(Boolean eBSEnabled)` Whether EBS-based storage is enabled.
`EBSOptions`	`withIops(Integer iops)` The IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
`EBSOptions`	`withThroughput(Integer throughput)` The Throughput for GP3 EBS volume (SSD).
`EBSOptions`	`withVolumeSize(Integer volumeSize)` Integer to specify the size of an EBS volume.
`EBSOptions`	`withVolumeType(String volumeType)` The volume type for EBS-based storage.
`EBSOptions`	`withVolumeType(VolumeType volumeType)` The volume type for EBS-based storage.

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

- Constructor Detail
  - EBSOptions
```
public EBSOptions()
```
- Method Detail
  - setEBSEnabled
```
public void setEBSEnabled(Boolean eBSEnabled)
```
    Whether EBS-based storage is enabled.
    
    Parameters:
    
    eBSEnabled - Whether EBS-based storage is enabled.
  - getEBSEnabled
```
public Boolean getEBSEnabled()
```
    Whether EBS-based storage is enabled.
    
    Returns:
    
    Whether EBS-based storage is enabled.
  - withEBSEnabled
```
public EBSOptions withEBSEnabled(Boolean eBSEnabled)
```
    Whether EBS-based storage is enabled.
    
    Parameters:
    
    eBSEnabled - Whether EBS-based storage is enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEBSEnabled
```
public Boolean isEBSEnabled()
```
    Whether EBS-based storage is enabled.
    
    Returns:
    
    Whether EBS-based storage is enabled.
  - setVolumeType
```
public void setVolumeType(String volumeType)
```
    The volume type for EBS-based storage.
    
    Parameters:
    
    volumeType - The volume type for EBS-based storage.
    
    See Also:
    
    VolumeType
  - getVolumeType
```
public String getVolumeType()
```
    The volume type for EBS-based storage.
    
    Returns:
    
    The volume type for EBS-based storage.
    
    See Also:
    
    VolumeType
  - withVolumeType
```
public EBSOptions withVolumeType(String volumeType)
```
    The volume type for EBS-based storage.
    
    Parameters:
    
    volumeType - The volume type for EBS-based storage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeType
  - withVolumeType
```
public EBSOptions withVolumeType(VolumeType volumeType)
```
    The volume type for EBS-based storage.
    
    Parameters:
    
    volumeType - The volume type for EBS-based storage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeType
  - setVolumeSize
```
public void setVolumeSize(Integer volumeSize)
```
    Integer to specify the size of an EBS volume.
    
    Parameters:
    
    volumeSize - Integer to specify the size of an EBS volume.
  - getVolumeSize
```
public Integer getVolumeSize()
```
    Integer to specify the size of an EBS volume.
    
    Returns:
    
    Integer to specify the size of an EBS volume.
  - withVolumeSize
```
public EBSOptions withVolumeSize(Integer volumeSize)
```
    Integer to specify the size of an EBS volume.
    
    Parameters:
    
    volumeSize - Integer to specify the size of an EBS volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIops
```
public void setIops(Integer iops)
```
    The IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
    
    Parameters:
    
    iops - The IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
  - getIops
```
public Integer getIops()
```
    The IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
    
    Returns:
    
    The IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
  - withIops
```
public EBSOptions withIops(Integer iops)
```
    The IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
    
    Parameters:
    
    iops - The IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThroughput
```
public void setThroughput(Integer throughput)
```
    The Throughput for GP3 EBS volume (SSD).
    
    Parameters:
    
    throughput - The Throughput for GP3 EBS volume (SSD).
  - getThroughput
```
public Integer getThroughput()
```
    The Throughput for GP3 EBS volume (SSD).
    
    Returns:
    
    The Throughput for GP3 EBS volume (SSD).
  - withThroughput
```
public EBSOptions withThroughput(Integer throughput)
```
    The Throughput for GP3 EBS volume (SSD).
    
    Parameters:
    
    throughput - The Throughput for GP3 EBS volume (SSD).
    
    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)
```
    Specified by:
    
    marshall in interface StructuredPojo

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