@Generated(value="software.amazon.awssdk:codegen") public class EbsBlockDevice extends Object implements ToCopyableBuilder<EbsBlockDevice.Builder,EbsBlockDevice>
Describes a block device for an EBS volume.
Modifier and Type | Class and Description |
---|---|
static interface |
EbsBlockDevice.Builder |
Modifier and Type | Method and Description |
---|---|
static EbsBlockDevice.Builder |
builder() |
Boolean |
deleteOnTermination()
Indicates whether the EBS volume is deleted on instance termination.
|
Boolean |
encrypted()
Indicates whether the EBS volume is encrypted.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Integer |
iops()
The number of I/O operations per second (IOPS) that the volume supports.
|
static Class<? extends EbsBlockDevice.Builder> |
serializableBuilderClass() |
String |
snapshotId()
The ID of the snapshot.
|
EbsBlockDevice.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Integer |
volumeSize()
The size of the volume, in GiB.
|
VolumeType |
volumeType()
The volume type:
gp2 , io1 , st1 , sc1 , or standard
. |
String |
volumeTypeString()
The volume type:
gp2 , io1 , st1 , sc1 , or standard
. |
copy
public Boolean encrypted()
Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. This is because only blank volumes can be encrypted on creation.
public Boolean deleteOnTermination()
Indicates whether the EBS volume is deleted on instance termination.
public 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 about 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 create gp2
, st1
, sc1
, or standard
volumes.
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 about 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 create gp2
, st1
, sc1
, or standard
volumes.
public String snapshotId()
The ID of the snapshot.
public 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.
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 VolumeType volumeType()
The volume type: gp2
, io1
, st1
, sc1
, or standard
.
Default: standard
If the service returns an enum value that is not available in the current SDK version, volumeType
will
return VolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
volumeTypeString()
.
gp2
, io1
, st1
, sc1
, or
standard
.
Default: standard
VolumeType
public String volumeTypeString()
The volume type: gp2
, io1
, st1
, sc1
, or standard
.
Default: standard
If the service returns an enum value that is not available in the current SDK version, volumeType
will
return VolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
volumeTypeString()
.
gp2
, io1
, st1
, sc1
, or
standard
.
Default: standard
VolumeType
public EbsBlockDevice.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<EbsBlockDevice.Builder,EbsBlockDevice>
public static EbsBlockDevice.Builder builder()
public static Class<? extends EbsBlockDevice.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.