Class EbsBlockDevice
- All Implemented Interfaces:
Serializable
,Cloneable
Describes a block device for an EBS volume.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Indicates whether the EBS volume is deleted on instance termination.Indicates whether the EBS volume is encrypted.getIops()
The number of I/O operations per second (IOPS) that the volume supports.The ID of the snapshot.The size of the volume, in GiB.The volume type:gp2
,io1
,st1
,sc1
, orstandard
.int
hashCode()
Indicates whether the EBS volume is deleted on instance termination.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
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
(VolumeType volumeType) The volume type:gp2
,io1
,st1
,sc1
, orstandard
.void
setVolumeType
(String volumeType) The volume type:gp2
,io1
,st1
,sc1
, orstandard
.toString()
Returns a string representation of this object; useful for testing and debugging.withDeleteOnTermination
(Boolean deleteOnTermination) Indicates whether the EBS volume is deleted on instance termination.withEncrypted
(Boolean encrypted) Indicates whether the EBS volume is encrypted.The number of I/O operations per second (IOPS) that the volume supports.withSnapshotId
(String snapshotId) The ID of the snapshot.withVolumeSize
(Integer volumeSize) The size of the volume, in GiB.withVolumeType
(VolumeType volumeType) The volume type:gp2
,io1
,st1
,sc1
, orstandard
.withVolumeType
(String volumeType) The volume type:gp2
,io1
,st1
,sc1
, orstandard
.
-
Constructor Details
-
EbsBlockDevice
public EbsBlockDevice()
-
-
Method Details
-
setSnapshotId
The ID of the snapshot.
- Parameters:
snapshotId
- The ID of the snapshot.
-
getSnapshotId
The ID of the snapshot.
- Returns:
- The ID of the snapshot.
-
withSnapshotId
The ID of the snapshot.
- Parameters:
snapshotId
- The ID of the snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setVolumeSize
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.
-
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.
-
withVolumeSize
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDeleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
- Parameters:
deleteOnTermination
- Indicates whether the EBS volume is deleted on instance termination.
-
getDeleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
- Returns:
- Indicates whether the EBS volume is deleted on instance termination.
-
withDeleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
- Parameters:
deleteOnTermination
- Indicates whether the EBS volume is deleted on instance termination.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isDeleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
- Returns:
- Indicates whether the EBS volume is deleted on instance termination.
-
setVolumeType
The volume type:
gp2
,io1
,st1
,sc1
, orstandard
.Default:
standard
- Parameters:
volumeType
- The volume type:gp2
,io1
,st1
,sc1
, orstandard
.Default:
standard
- See Also:
-
getVolumeType
The volume type:
gp2
,io1
,st1
,sc1
, orstandard
.Default:
standard
- Returns:
- The volume type:
gp2
,io1
,st1
,sc1
, orstandard
.Default:
standard
- See Also:
-
withVolumeType
The volume type:
gp2
,io1
,st1
,sc1
, orstandard
.Default:
standard
- Parameters:
volumeType
- The volume type:gp2
,io1
,st1
,sc1
, orstandard
.Default:
standard
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setVolumeType
The volume type:
gp2
,io1
,st1
,sc1
, orstandard
.Default:
standard
- Parameters:
volumeType
- The volume type:gp2
,io1
,st1
,sc1
, orstandard
.Default:
standard
- See Also:
-
withVolumeType
The volume type:
gp2
,io1
,st1
,sc1
, orstandard
.Default:
standard
- Parameters:
volumeType
- The volume type:gp2
,io1
,st1
,sc1
, orstandard
.Default:
standard
- 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 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
volumes; it is not used in requests to createio1
gp2
,st1
,sc1
, orstandard
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. Forgp2
, 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
volumes; it is not used in requests to createio1
gp2
,st1
,sc1
, orstandard
volumes.
-
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
volumes; it is not used in requests to createio1
gp2
,st1
,sc1
, orstandard
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
volumes; it is not used in requests to createio1
gp2
,st1
,sc1
, orstandard
volumes.
-
withIops
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
volumes; it is not used in requests to createio1
gp2
,st1
,sc1
, orstandard
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. Forgp2
, 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
volumes; it is not used in requests to createio1
gp2
,st1
,sc1
, orstandard
volumes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEncrypted
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.
-
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.
-
withEncrypted
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-