public class EbsBlockDevice
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Describes a block device for an EBS volume.
Modifier and Type | Field and Description |
---|---|
private java.lang.Boolean |
deleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
|
private java.lang.Boolean |
encrypted
Indicates whether the EBS volume is encrypted.
|
private java.lang.Integer |
iops
The number of I/O operations per second (IOPS) that the volume supports.
|
private java.lang.String |
snapshotId
The ID of the snapshot.
|
private java.lang.Integer |
volumeSize
The size of the volume, in GiB.
|
private java.lang.String |
volumeType
The volume type:
gp2 , io1 , st1 ,
sc1 , or standard . |
Constructor and Description |
---|
EbsBlockDevice() |
Modifier and Type | Method and Description |
---|---|
EbsBlockDevice |
clone() |
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 . |
private java.lang.String snapshotId
The ID of the snapshot.
private 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.
private java.lang.Boolean deleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
private java.lang.String volumeType
The volume type: gp2
, io1
, st1
,
sc1
, or standard
.
Default: standard
private 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
volumes; it is not used in requests to
create io1
gp2
, st1
, sc1
, or
standard
volumes.
private 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.
public void setSnapshotId(java.lang.String snapshotId)
The ID of the snapshot.
snapshotId
- The ID of the snapshot.public java.lang.String getSnapshotId()
The ID of the snapshot.
public EbsBlockDevice withSnapshotId(java.lang.String snapshotId)
The ID of the snapshot.
snapshotId
- The ID of the snapshot.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.
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.
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.
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.
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.
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.
public void setDeleteOnTermination(java.lang.Boolean deleteOnTermination)
Indicates whether the EBS volume is deleted on instance termination.
deleteOnTermination
- Indicates whether the EBS volume is deleted on instance
termination.public java.lang.Boolean getDeleteOnTermination()
Indicates whether the EBS volume is deleted on instance termination.
public EbsBlockDevice withDeleteOnTermination(java.lang.Boolean deleteOnTermination)
Indicates whether the EBS volume is deleted on instance termination.
deleteOnTermination
- Indicates whether the EBS volume is deleted on instance
termination.public java.lang.Boolean isDeleteOnTermination()
Indicates whether the EBS volume is deleted on instance termination.
public void setVolumeType(java.lang.String volumeType)
The volume type: gp2
, io1
, st1
,
sc1
, or standard
.
Default: standard
volumeType
- The volume type: gp2
, io1
,
st1
, sc1
, or standard
.
Default: standard
VolumeType
public java.lang.String getVolumeType()
The volume type: gp2
, io1
, st1
,
sc1
, or standard
.
Default: standard
gp2
, io1
,
st1
, sc1
, or standard
.
Default: standard
VolumeType
public EbsBlockDevice withVolumeType(java.lang.String volumeType)
The volume type: gp2
, io1
, st1
,
sc1
, or standard
.
Default: standard
volumeType
- The volume type: gp2
, io1
,
st1
, sc1
, or standard
.
Default: standard
VolumeType
public void setVolumeType(VolumeType volumeType)
The volume type: gp2
, io1
, st1
,
sc1
, or standard
.
Default: standard
volumeType
- The volume type: gp2
, io1
,
st1
, sc1
, or standard
.
Default: standard
VolumeType
public EbsBlockDevice withVolumeType(VolumeType volumeType)
The volume type: gp2
, io1
, st1
,
sc1
, or standard
.
Default: standard
volumeType
- The volume type: gp2
, io1
,
st1
, sc1
, or standard
.
Default: standard
VolumeType
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
volumes; it is not used in requests to
create io1
gp2
, st1
, sc1
, or
standard
volumes.
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
volumes; it is not used in requests
to create io1
gp2
, st1
, sc1
, or
standard
volumes.
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
volumes; it is not used in requests to
create io1
gp2
, st1
, sc1
, or
standard
volumes.
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 create io1
gp2
, st1
, sc1
,
or standard
volumes.
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
volumes; it is not used in requests to
create io1
gp2
, st1
, sc1
, or
standard
volumes.
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
volumes; it is not used in requests
to create io1
gp2
, st1
, sc1
, or
standard
volumes.
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.
encrypted
- Indicates whether the EBS volume is encrypted. Encrypted Amazon
EBS volumes may only be attached to instances that support Amazon
EBS encryption.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.
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.
encrypted
- Indicates whether the EBS volume is encrypted. Encrypted Amazon
EBS volumes may only be attached to instances that support Amazon
EBS encryption.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.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public EbsBlockDevice clone()
clone
in class java.lang.Object