Class Volume
- All Implemented Interfaces:
Serializable
,Cloneable
Describes a volume.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Information about the volume attachments.The Availability Zone for the volume.The time stamp when volume creation was initiated.Indicates whether the volume will be encrypted.getIops()
The number of I/O operations per second (IOPS) that the volume supports.The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.getSize()
The size of the volume, in GiBs.The snapshot from which the volume was created, if applicable.getState()
The volume state.getTags()
Any tags assigned to the volume.The ID of the volume.The volume type.int
hashCode()
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
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 (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.void
The size of the volume, in GiBs.void
setSnapshotId
(String snapshotId) The snapshot from which the volume was created, if applicable.void
setState
(VolumeState state) The volume state.void
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
(VolumeType volumeType) The volume type.void
setVolumeType
(String volumeType) The volume type.toString()
Returns a string representation of this object; useful for testing and debugging.withAttachments
(VolumeAttachment... attachments) Information about the volume attachments.withAttachments
(Collection<VolumeAttachment> attachments) Information about the volume attachments.withAvailabilityZone
(String availabilityZone) The Availability Zone for the volume.withCreateTime
(Date createTime) The time stamp when volume creation was initiated.withEncrypted
(Boolean encrypted) Indicates whether the volume will be encrypted.The number of I/O operations per second (IOPS) that the volume supports.withKmsKeyId
(String kmsKeyId) The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.The size of the volume, in GiBs.withSnapshotId
(String snapshotId) The snapshot from which the volume was created, if applicable.withState
(VolumeState state) The volume state.The volume state.Any tags assigned to the volume.withTags
(Collection<Tag> tags) Any tags assigned to the volume.withVolumeId
(String volumeId) The ID of the volume.withVolumeType
(VolumeType volumeType) The volume type.withVolumeType
(String volumeType) The volume type.
-
Constructor Details
-
Volume
public Volume()
-
-
Method Details
-
setVolumeId
The ID of the volume.
- Parameters:
volumeId
- The ID of the volume.
-
getVolumeId
The ID of the volume.
- Returns:
- The ID of the volume.
-
withVolumeId
The ID of the volume.
- Parameters:
volumeId
- The ID of the volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSize
The size of the volume, in GiBs.
- Parameters:
size
- The size of the volume, in GiBs.
-
getSize
The size of the volume, in GiBs.
- Returns:
- The size of the volume, in GiBs.
-
withSize
The size of the volume, in GiBs.
- Parameters:
size
- The size of the volume, in GiBs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshotId
The snapshot from which the volume was created, if applicable.
- Parameters:
snapshotId
- The snapshot from which the volume was created, if applicable.
-
getSnapshotId
The snapshot from which the volume was created, if applicable.
- Returns:
- The snapshot from which the volume was created, if applicable.
-
withSnapshotId
The snapshot from which the volume was created, if applicable.
- Parameters:
snapshotId
- The snapshot from which the volume was created, if applicable.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAvailabilityZone
The Availability Zone for the volume.
- Parameters:
availabilityZone
- The Availability Zone for the volume.
-
getAvailabilityZone
The Availability Zone for the volume.
- Returns:
- The Availability Zone for the volume.
-
withAvailabilityZone
The Availability Zone for the volume.
- Parameters:
availabilityZone
- The Availability Zone for the volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setState
The volume state.
- Parameters:
state
- The volume state.- See Also:
-
getState
The volume state.
- Returns:
- The volume state.
- See Also:
-
withState
The volume state.
- Parameters:
state
- The volume state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setState
The volume state.
- Parameters:
state
- The volume state.- See Also:
-
withState
The volume state.
- Parameters:
state
- The volume state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setCreateTime
The time stamp when volume creation was initiated.
- Parameters:
createTime
- The time stamp when volume creation was initiated.
-
getCreateTime
The time stamp when volume creation was initiated.
- Returns:
- The time stamp when volume creation was initiated.
-
withCreateTime
The time stamp when volume creation was initiated.
- Parameters:
createTime
- The time stamp when volume creation was initiated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getAttachments
Information about the volume attachments.
- Returns:
- Information about the volume attachments.
-
setAttachments
Information about the volume attachments.
- Parameters:
attachments
- Information about the volume attachments.
-
withAttachments
Information about the volume attachments.
NOTE: This method appends the values to the existing list (if any). Use
setAttachments(java.util.Collection)
orwithAttachments(java.util.Collection)
if you want to override the existing values.- Parameters:
attachments
- Information about the volume attachments.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withAttachments
Information about the volume attachments.
- Parameters:
attachments
- Information about the volume attachments.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getTags
Any tags assigned to the volume.
- Returns:
- Any tags assigned to the volume.
-
setTags
Any tags assigned to the volume.
- Parameters:
tags
- Any tags assigned to the volume.
-
withTags
Any tags assigned to the volume.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
- Any tags assigned to the volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
Any tags assigned to the volume.
- Parameters:
tags
- Any tags assigned to the volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setVolumeType
The volume type. This can be
gp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.- Parameters:
volumeType
- The volume type. This can begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.- See Also:
-
getVolumeType
The volume type. This can be
gp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.- Returns:
- The volume type. This can be
gp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes. - See Also:
-
withVolumeType
The volume type. This can be
gp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.- Parameters:
volumeType
- The volume type. This can begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setVolumeType
The volume type. This can be
gp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.- Parameters:
volumeType
- The volume type. This can begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.- See Also:
-
withVolumeType
The volume type. This can be
gp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.- Parameters:
volumeType
- The volume type. This can begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setIops
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-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 creategp2
,st1
,sc1
, orstandard
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-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 creategp2
,st1
,sc1
, orstandard
volumes.
-
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-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 creategp2
,st1
,sc1
, orstandard
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-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 creategp2
,st1
,sc1
, orstandard
volumes.
-
withIops
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-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 creategp2
,st1
,sc1
, orstandard
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-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 creategp2
,st1
,sc1
, orstandard
volumes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEncrypted
Indicates whether the volume will be encrypted.
- Parameters:
encrypted
- Indicates whether the volume will be encrypted.
-
getEncrypted
Indicates whether the volume will be encrypted.
- Returns:
- Indicates whether the volume will be encrypted.
-
withEncrypted
Indicates whether the volume will be encrypted.
- Parameters:
encrypted
- Indicates whether the volume will be encrypted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isEncrypted
Indicates whether the volume will be encrypted.
- Returns:
- Indicates whether the volume will be encrypted.
-
setKmsKeyId
The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
- Parameters:
kmsKeyId
- The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
-
getKmsKeyId
The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
- Returns:
- The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
-
withKmsKeyId
The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
- Parameters:
kmsKeyId
- The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-