EbsBlockDevice (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.ec2.model.EbsBlockDevice

All Implemented Interfaces:

java.io.Serializable
```
public class EbsBlockDevice
extends java.lang.Object
implements java.io.Serializable
```
Describes a block device for an EBS volume.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

EbsBlockDevice()

Constructors
Constructor and Description
`EbsBlockDevice()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Boolean`	`getDeleteOnTermination()` Indicates whether the EBS volume is deleted on instance termination.
`java.lang.Boolean`	`getEncrypted()` Indicates whether the EBS volume is encrypted.
`java.lang.Integer`	`getIops()` The number of I/O operations per second (IOPS) that the volume supports.
`java.lang.String`	`getSnapshotId()` The ID of the snapshot.
`java.lang.Integer`	`getVolumeSize()` The size of the volume, in GiB.
`java.lang.String`	`getVolumeType()` The volume type: `gp2`, `io1`, `st1`, `sc1`, or `standard`.
`int`	`hashCode()`
`java.lang.Boolean`	`isDeleteOnTermination()` Indicates whether the EBS volume is deleted on instance termination.
`java.lang.Boolean`	`isEncrypted()` Indicates whether the EBS volume is encrypted.
`void`	`setDeleteOnTermination(java.lang.Boolean deleteOnTermination)` Indicates whether the EBS volume is deleted on instance termination.
`void`	`setEncrypted(java.lang.Boolean encrypted)` Indicates whether the EBS volume is encrypted.
`void`	`setIops(java.lang.Integer iops)` The number of I/O operations per second (IOPS) that the volume supports.
`void`	`setSnapshotId(java.lang.String snapshotId)` The ID of the snapshot.
`void`	`setVolumeSize(java.lang.Integer volumeSize)` The size of the volume, in GiB.
`void`	`setVolumeType(java.lang.String volumeType)` The volume type: `gp2`, `io1`, `st1`, `sc1`, or `standard`.
`void`	`setVolumeType(VolumeType volumeType)` The volume type: `gp2`, `io1`, `st1`, `sc1`, or `standard`.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`EbsBlockDevice`	`withDeleteOnTermination(java.lang.Boolean deleteOnTermination)` Indicates whether the EBS volume is deleted on instance termination.
`EbsBlockDevice`	`withEncrypted(java.lang.Boolean encrypted)` Indicates whether the EBS volume is encrypted.
`EbsBlockDevice`	`withIops(java.lang.Integer iops)` The number of I/O operations per second (IOPS) that the volume supports.
`EbsBlockDevice`	`withSnapshotId(java.lang.String snapshotId)` The ID of the snapshot.
`EbsBlockDevice`	`withVolumeSize(java.lang.Integer volumeSize)` The size of the volume, in GiB.
`EbsBlockDevice`	`withVolumeType(java.lang.String volumeType)` The volume type: `gp2`, `io1`, `st1`, `sc1`, or `standard`.
`EbsBlockDevice`	`withVolumeType(VolumeType volumeType)` The volume type: `gp2`, `io1`, `st1`, `sc1`, or `standard`.

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

- Constructor Detail
  - EbsBlockDevice
```
public EbsBlockDevice()
```
- Method Detail
  - getSnapshotId
```
public java.lang.String getSnapshotId()
```
    The ID of the snapshot.
    
    Returns:
    
    The ID of the snapshot.
  - setSnapshotId
```
public void setSnapshotId(java.lang.String snapshotId)
```
    The ID of the snapshot.
    
    Parameters:
    
    snapshotId - The ID of the snapshot.
  - withSnapshotId
```
public EbsBlockDevice withSnapshotId(java.lang.String snapshotId)
```
    The ID of the snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    snapshotId - The ID of the snapshot.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getVolumeSize
```
public java.lang.Integer getVolumeSize()
```
    The size of the volume, in GiB.
    Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
    Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
    
    Returns:
    
    The size of the volume, in GiB.
    Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
    Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
  - setVolumeSize
```
public void setVolumeSize(java.lang.Integer volumeSize)
```
    The size of the volume, in GiB.
    Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
    Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
    
    Parameters:
    
    volumeSize - The size of the volume, in GiB.
    Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
    Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
  - withVolumeSize
```
public EbsBlockDevice withVolumeSize(java.lang.Integer volumeSize)
```
    The size of the volume, in GiB.
    Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
    Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    volumeSize - The size of the volume, in GiB.
    Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
    Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isDeleteOnTermination
```
public java.lang.Boolean isDeleteOnTermination()
```
    Indicates whether the EBS volume is deleted on instance termination.
    
    Returns:
    
    Indicates whether the EBS volume is deleted on instance termination.
  - setDeleteOnTermination
```
public void setDeleteOnTermination(java.lang.Boolean deleteOnTermination)
```
    Indicates whether the EBS volume is deleted on instance termination.
    
    Parameters:
    
    deleteOnTermination - Indicates whether the EBS volume is deleted on instance termination.
  - withDeleteOnTermination
```
public EbsBlockDevice withDeleteOnTermination(java.lang.Boolean deleteOnTermination)
```
    Indicates whether the EBS volume is deleted on instance termination.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    deleteOnTermination - Indicates whether the EBS volume is deleted on instance termination.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDeleteOnTermination
```
public java.lang.Boolean getDeleteOnTermination()
```
    Indicates whether the EBS volume is deleted on instance termination.
    
    Returns:
    
    Indicates whether the EBS volume is deleted on instance termination.
  - getVolumeType
```
public java.lang.String getVolumeType()
```
    The volume type: gp2, io1, st1, sc1, or standard.
    Default: standard
    Constraints:
    Allowed Values: standard, io1, gp2, sc1, st1
    
    Returns:
    
    The volume type: gp2, io1, st1, sc1, or standard.
    Default: standard
    
    See Also:
    
    VolumeType
  - setVolumeType
```
public void setVolumeType(java.lang.String volumeType)
```
    The volume type: gp2, io1, st1, sc1, or standard.
    Default: standard
    Constraints:
    Allowed Values: standard, io1, gp2, sc1, st1
    
    Parameters:
    
    volumeType - The volume type: gp2, io1, st1, sc1, or standard.
    Default: standard
    
    See Also:
    
    VolumeType
  - withVolumeType
```
public EbsBlockDevice withVolumeType(java.lang.String volumeType)
```
    The volume type: gp2, io1, st1, sc1, or standard.
    Default: standard
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: standard, io1, gp2, sc1, st1
    
    Parameters:
    
    volumeType - The volume type: gp2, io1, st1, sc1, or standard.
    Default: standard
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    VolumeType
  - setVolumeType
```
public void setVolumeType(VolumeType volumeType)
```
    The volume type: gp2, io1, st1, sc1, or standard.
    Default: standard
    Constraints:
    Allowed Values: standard, io1, gp2, sc1, st1
    
    Parameters:
    
    volumeType - The volume type: gp2, io1, st1, sc1, or standard.
    Default: standard
    
    See Also:
    
    VolumeType
  - withVolumeType
```
public EbsBlockDevice withVolumeType(VolumeType volumeType)
```
    The volume type: gp2, io1, st1, sc1, or standard.
    Default: standard
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: standard, io1, gp2, sc1, st1
    
    Parameters:
    
    volumeType - The volume type: gp2, io1, st1, sc1, or standard.
    Default: standard
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    VolumeType
  - getIops
```
public java.lang.Integer getIops()
```
    The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
    Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
    Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
    
    Returns:
    
    The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
    Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
    Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
  - setIops
```
public void setIops(java.lang.Integer iops)
```
    The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
    Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
    Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
    
    Parameters:
    
    iops - The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
    Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
    Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
  - withIops
```
public EbsBlockDevice withIops(java.lang.Integer iops)
```
    The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
    Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
    Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    iops - The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
    Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
    Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isEncrypted
```
public java.lang.Boolean isEncrypted()
```
    Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
    
    Returns:
    
    Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
  - setEncrypted
```
public void setEncrypted(java.lang.Boolean encrypted)
```
    Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
    
    Parameters:
    
    encrypted - Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
  - withEncrypted
```
public EbsBlockDevice withEncrypted(java.lang.Boolean encrypted)
```
    Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    encrypted - Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEncrypted
```
public java.lang.Boolean getEncrypted()
```
    Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
    
    Returns:
    
    Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class EbsBlockDevice

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EbsBlockDevice

Method Detail

getSnapshotId

setSnapshotId

withSnapshotId

getVolumeSize

setVolumeSize

withVolumeSize

isDeleteOnTermination

setDeleteOnTermination

withDeleteOnTermination

getDeleteOnTermination

getVolumeType

setVolumeType

withVolumeType

setVolumeType

withVolumeType

getIops

setIops

withIops

isEncrypted

setEncrypted

withEncrypted

getEncrypted

toString

hashCode

equals