com.amazonaws.services.ec2.model

Class Volume

java.lang.Object

com.amazonaws.services.ec2.model.Volume

All Implemented Interfaces:

Serializable, Cloneable

public class Volume
extends Object
implements Serializable, Cloneable

Describes a volume.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Volume()

Method Summary

Methods

Modifier and Type	Method and Description
Volume	clone()
boolean	equals(Object obj)
List<VolumeAttachment>	getAttachments() Information about the volume attachments.
String	getAvailabilityZone() The Availability Zone for the volume.
Date	getCreateTime() The time stamp when volume creation was initiated.
Boolean	getEncrypted() Indicates whether the volume will be encrypted.
Integer	getIops() The number of I/O operations per second (IOPS) that the volume supports.
String	getKmsKeyId() The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.
Integer	getSize() The size of the volume, in GiBs.
String	getSnapshotId() The snapshot from which the volume was created, if applicable.
String	getState() The volume state.
List<Tag>	getTags() Any tags assigned to the volume.
String	getVolumeId() The ID of the volume.
String	getVolumeType() The volume type.
int	hashCode()
Boolean	isEncrypted() Indicates whether the volume will be encrypted.
void	setAttachments(Collection<VolumeAttachment> attachments) Information about the volume attachments.
void	setAvailabilityZone(String availabilityZone) The Availability Zone for the volume.
void	setCreateTime(Date createTime) The time stamp when volume creation was initiated.
void	setEncrypted(Boolean encrypted) Indicates whether the volume will be encrypted.
void	setIops(Integer iops) The number of I/O operations per second (IOPS) that the volume supports.
void	setKmsKeyId(String kmsKeyId) The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.
void	setSize(Integer size) The size of the volume, in GiBs.
void	setSnapshotId(String snapshotId) The snapshot from which the volume was created, if applicable.
void	setState(String state) The volume state.
void	setState(VolumeState state) The volume state.
void	setTags(Collection<Tag> tags) Any tags assigned to the volume.
void	setVolumeId(String volumeId) The ID of the volume.
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.
Volume	withAttachments(Collection<VolumeAttachment> attachments) Information about the volume attachments.
Volume	withAttachments(VolumeAttachment... attachments) Information about the volume attachments.
Volume	withAvailabilityZone(String availabilityZone) The Availability Zone for the volume.
Volume	withCreateTime(Date createTime) The time stamp when volume creation was initiated.
Volume	withEncrypted(Boolean encrypted) Indicates whether the volume will be encrypted.
Volume	withIops(Integer iops) The number of I/O operations per second (IOPS) that the volume supports.
Volume	withKmsKeyId(String kmsKeyId) The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.
Volume	withSize(Integer size) The size of the volume, in GiBs.
Volume	withSnapshotId(String snapshotId) The snapshot from which the volume was created, if applicable.
Volume	withState(String state) The volume state.
Volume	withState(VolumeState state) The volume state.
Volume	withTags(Collection<Tag> tags) Any tags assigned to the volume.
Volume	withTags(Tag... tags) Any tags assigned to the volume.
Volume	withVolumeId(String volumeId) The ID of the volume.
Volume	withVolumeType(String volumeType) The volume type.
Volume	withVolumeType(VolumeType volumeType) The volume type.

Methods inherited from class java.lang.Object

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

Constructor Detail

Volume

public Volume()

Method Detail

getVolumeId

public String getVolumeId()

The ID of the volume.

Returns:

The ID of the volume.

setVolumeId

public void setVolumeId(String volumeId)

The ID of the volume.

Parameters:

volumeId - The ID of the volume.

withVolumeId

public Volume withVolumeId(String volumeId)

The ID of the volume.

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

Parameters:

volumeId - The ID of the volume.

Returns:

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

getSize

public Integer getSize()

The size of the volume, in GiBs.

Returns:

The size of the volume, in GiBs.

setSize

public void setSize(Integer size)

The size of the volume, in GiBs.

Parameters:

size - The size of the volume, in GiBs.

withSize

public Volume withSize(Integer size)

The size of the volume, in GiBs.

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

Parameters:

size - The size of the volume, in GiBs.

Returns:

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

getSnapshotId

public String getSnapshotId()

The snapshot from which the volume was created, if applicable.

Returns:

The snapshot from which the volume was created, if applicable.

setSnapshotId

public void setSnapshotId(String snapshotId)

The snapshot from which the volume was created, if applicable.

Parameters:

snapshotId - The snapshot from which the volume was created, if applicable.

withSnapshotId

public Volume withSnapshotId(String snapshotId)

The snapshot from which the volume was created, if applicable.

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

Parameters:

snapshotId - The snapshot from which the volume was created, if applicable.

Returns:

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

getAvailabilityZone

public String getAvailabilityZone()

The Availability Zone for the volume.

Returns:

The Availability Zone for the volume.

setAvailabilityZone

public void setAvailabilityZone(String availabilityZone)

The Availability Zone for the volume.

Parameters:

availabilityZone - The Availability Zone for the volume.

withAvailabilityZone

public Volume withAvailabilityZone(String availabilityZone)

The Availability Zone for the volume.

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

Parameters:

availabilityZone - The Availability Zone for the volume.

Returns:

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

getState

public String getState()

The volume state.

Constraints:
Allowed Values: creating, available, in-use, deleting, deleted, error

Returns:

The volume state.

See Also:

VolumeState

setState

public void setState(String state)

The volume state.

Constraints:
Allowed Values: creating, available, in-use, deleting, deleted, error

Parameters:

state - The volume state.

See Also:

VolumeState

withState

public Volume withState(String state)

The volume state.

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

Constraints:
Allowed Values: creating, available, in-use, deleting, deleted, error

Parameters:

state - The volume state.

Returns:

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

See Also:

VolumeState

setState

public void setState(VolumeState state)

The volume state.

Constraints:
Allowed Values: creating, available, in-use, deleting, deleted, error

Parameters:

state - The volume state.

See Also:

VolumeState

withState

public Volume withState(VolumeState state)

The volume state.

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

Constraints:
Allowed Values: creating, available, in-use, deleting, deleted, error

Parameters:

state - The volume state.

Returns:

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

See Also:

VolumeState

getCreateTime

public Date getCreateTime()

The time stamp when volume creation was initiated.

Returns:

The time stamp when volume creation was initiated.

setCreateTime

public void setCreateTime(Date createTime)

The time stamp when volume creation was initiated.

Parameters:

createTime - The time stamp when volume creation was initiated.

withCreateTime

public Volume withCreateTime(Date createTime)

The time stamp when volume creation was initiated.

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

Parameters:

createTime - The time stamp when volume creation was initiated.

Returns:

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

getAttachments

public List<VolumeAttachment> getAttachments()

Information about the volume attachments.

Returns:

Information about the volume attachments.

setAttachments

public void setAttachments(Collection<VolumeAttachment> attachments)

Information about the volume attachments.

Parameters:

attachments - Information about the volume attachments.

withAttachments

public Volume withAttachments(VolumeAttachment... attachments)

Information about the volume attachments.

NOTE: This method appends the values to the existing list (if any). Use setAttachments(java.util.Collection) or withAttachments(java.util.Collection) if you want to override the existing values.

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

Parameters:

attachments - Information about the volume attachments.

Returns:

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

withAttachments

public Volume withAttachments(Collection<VolumeAttachment> attachments)

Information about the volume attachments.

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

Parameters:

attachments - Information about the volume attachments.

Returns:

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

getTags

public List<Tag> getTags()

Any tags assigned to the volume.

Returns:

Any tags assigned to the volume.

setTags

public void setTags(Collection<Tag> tags)

Any tags assigned to the volume.

Parameters:

tags - Any tags assigned to the volume.

withTags

public Volume withTags(Tag... tags)

Any tags assigned to the volume.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

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

Parameters:

tags - Any tags assigned to the volume.

Returns:

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

withTags

public Volume withTags(Collection<Tag> tags)

Any tags assigned to the volume.

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

Parameters:

tags - Any tags assigned to the volume.

Returns:

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

getVolumeType

public String getVolumeType()

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

Constraints:
Allowed Values: standard, io1, gp2

Returns:

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

See Also:

VolumeType

setVolumeType

public void setVolumeType(String volumeType)

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

Constraints:
Allowed Values: standard, io1, gp2

Parameters:

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

See Also:

VolumeType

withVolumeType

public Volume withVolumeType(String volumeType)

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

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. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

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. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

Constraints:
Allowed Values: standard, io1, gp2

Parameters:

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

See Also:

VolumeType

withVolumeType

public Volume withVolumeType(VolumeType volumeType)

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

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. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

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 Volume 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 volume will be encrypted.

Returns:

Indicates whether the volume will be encrypted.

setEncrypted

public void setEncrypted(Boolean encrypted)

Indicates whether the volume will be encrypted.

Parameters:

encrypted - Indicates whether the volume will be encrypted.

withEncrypted

public Volume withEncrypted(Boolean encrypted)

Indicates whether the volume will be encrypted.

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

Parameters:

encrypted - Indicates whether the volume will be encrypted.

Returns:

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

getEncrypted

public Boolean getEncrypted()

Indicates whether the volume will be encrypted.

Returns:

Indicates whether the volume will be encrypted.

getKmsKeyId

public String getKmsKeyId()

The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.

Returns:

The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.

Parameters:

kmsKeyId - The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.

withKmsKeyId

public Volume withKmsKeyId(String kmsKeyId)

The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.

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

Parameters:

kmsKeyId - The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.

Returns:

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

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 Volume clone()

Overrides:

clone in class Object