com.amazonaws.services.ec2.model

Class EbsBlockDevice

java.lang.Object

com.amazonaws.services.ec2.model.EbsBlockDevice

All Implemented Interfaces:

Serializable, Cloneable

public class EbsBlockDevice
extends Object
implements Serializable, Cloneable

Describes a block device for an EBS volume.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EbsBlockDevice()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EbsBlockDevice

public EbsBlockDevice()

Method Detail

getSnapshotId

public String getSnapshotId()

The ID of the snapshot.

Returns:

The ID of the snapshot.

setSnapshotId

public void setSnapshotId(String snapshotId)

The ID of the snapshot.

Parameters:

snapshotId - The ID of the snapshot.

withSnapshotId

public EbsBlockDevice withSnapshotId(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 Integer getVolumeSize()

The size of the volume, in GiB.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 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-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 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(Integer volumeSize)

The size of the volume, in GiB.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 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-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 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(Integer volumeSize)

The size of the volume, in GiB.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 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-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 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 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(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(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 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 String getVolumeType()

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

Constraints:
Allowed Values: standard, io1, gp2

Returns:

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

See Also:

VolumeType

setVolumeType

public void setVolumeType(String volumeType)

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

Constraints:
Allowed Values: standard, io1, gp2

Parameters:

volumeType - The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

See Also:

VolumeType

withVolumeType

public EbsBlockDevice withVolumeType(String volumeType)

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: standard, io1, gp2

Parameters:

volumeType - The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

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 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

Constraints:
Allowed Values: standard, io1, gp2

Parameters:

volumeType - The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

See Also:

VolumeType

withVolumeType

public EbsBlockDevice withVolumeType(VolumeType volumeType)

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: standard, io1, gp2

Parameters:

volumeType - The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VolumeType

getIops

public Integer getIops()

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, 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 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

Returns:

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, 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 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

setIops

public void setIops(Integer iops)

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, 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 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

Parameters:

iops - The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, 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 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

withIops

public EbsBlockDevice withIops(Integer iops)

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, 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 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 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 Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, 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 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

Returns:

A reference to this updated object so that method calls can be chained together.

isEncrypted

public 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(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(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 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 String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public EbsBlockDevice clone()

Overrides:

clone in class Object