Class EbsBlockDevice
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EbsBlockDevice.Builder,
EbsBlockDevice>
Describes a block device for an EBS volume.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EbsBlockDevice.Builder
builder()
final Boolean
Indicates whether the EBS volume is deleted on instance termination.final Boolean
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
iops()
The number of I/O operations per second (IOPS).final String
kmsKeyId()
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.final String
The ARN of the Outpost on which the snapshot is stored.static Class
<? extends EbsBlockDevice.Builder> final String
The ID of the snapshot.final Integer
The throughput that the volume supports, in MiB/s.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
The size of the volume, in GiBs.final VolumeType
The volume type.final String
The volume type.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
deleteOnTermination
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.
- Returns:
- Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.
-
iops
The number of I/O operations per second (IOPS). For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.The following are the supported values for each volume type:
-
gp3
: 3,000 - 16,000 IOPS -
io1
: 100 - 64,000 IOPS -
io2
: 100 - 256,000 IOPS
For
io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.This parameter is required for
io1
andio2
volumes. The default forgp3
volumes is 3,000 IOPS.- Returns:
- The number of I/O operations per second (IOPS). For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.The following are the supported values for each volume type:
-
gp3
: 3,000 - 16,000 IOPS -
io1
: 100 - 64,000 IOPS -
io2
: 100 - 256,000 IOPS
For
io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.This parameter is required for
io1
andio2
volumes. The default forgp3
volumes is 3,000 IOPS. -
-
-
snapshotId
The ID of the snapshot.
- Returns:
- The ID of the snapshot.
-
volumeSize
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported sizes for each volume type:
-
gp2
andgp3
: 1 - 16,384 GiB -
io1
: 4 - 16,384 GiB -
io2
: 4 - 65,536 GiB -
st1
andsc1
: 125 - 16,384 GiB -
standard
: 1 - 1024 GiB
- Returns:
- The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a
snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than
the snapshot size.
The following are the supported sizes for each volume type:
-
gp2
andgp3
: 1 - 16,384 GiB -
io1
: 4 - 16,384 GiB -
io2
: 4 - 65,536 GiB -
st1
andsc1
: 125 - 16,384 GiB -
standard
: 1 - 1024 GiB
-
-
-
volumeType
The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
If the service returns an enum value that is not available in the current SDK version,
volumeType
will returnVolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvolumeTypeAsString()
.- Returns:
- The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
- See Also:
-
volumeTypeAsString
The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
If the service returns an enum value that is not available in the current SDK version,
volumeType
will returnVolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvolumeTypeAsString()
.- Returns:
- The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
- See Also:
-
kmsKeyId
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on
BlockDeviceMapping
objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.- Returns:
- Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS
volume is encrypted.
This parameter is only supported on
BlockDeviceMapping
objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
-
throughput
The throughput that the volume supports, in MiB/s.
This parameter is valid only for
gp3
volumes.Valid Range: Minimum value of 125. Maximum value of 1000.
- Returns:
- The throughput that the volume supports, in MiB/s.
This parameter is valid only for
gp3
volumes.Valid Range: Minimum value of 125. Maximum value of 1000.
-
outpostArn
The ARN of the Outpost on which the snapshot is stored.
This parameter is not supported when using CreateImage.
- Returns:
- The ARN of the Outpost on which the snapshot is stored.
This parameter is not supported when using CreateImage.
-
encrypted
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to
true
depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by DescribeImageAttribute.
For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
-
If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either
true
for an encrypted volume, orfalse
for an unencrypted volume. If you omit this parameter, it defaults tofalse
(unencrypted). -
If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
-
If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify
false
. If you specifytrue
, the request will fail. In this case, we recommend that you omit the parameter. -
If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either
true
orfalse
. However, if you specifyfalse
, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
- Returns:
- Indicates whether the encryption state of an EBS volume is changed while being restored from a backing
snapshot. The effect of setting the encryption state to
true
depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by DescribeImageAttribute.
For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
-
If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either
true
for an encrypted volume, orfalse
for an unencrypted volume. If you omit this parameter, it defaults tofalse
(unencrypted). -
If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
-
If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify
false
. If you specifytrue
, the request will fail. In this case, we recommend that you omit the parameter. -
If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either
true
orfalse
. However, if you specifyfalse
, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<EbsBlockDevice.Builder,
EbsBlockDevice> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-