Class BlockDeviceMapping
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BlockDeviceMapping.Builder,
BlockDeviceMapping>
Describes a block device mapping.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic BlockDeviceMapping.Builder
builder()
final String
The device name assigned to the volume (for example,/dev/sdh
orxvdh
).final Ebs
ebs()
Information to attach an EBS volume to an instance at launch.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 Boolean
noDevice()
Setting this value totrue
prevents a volume that is included in the block device mapping of the AMI from being mapped to the specified device name at launch.static Class
<? extends BlockDeviceMapping.Builder> 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 String
The name of the instance store volume (virtual device) to attach to an instance at launch.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
virtualName
The name of the instance store volume (virtual device) to attach to an instance at launch. The name must be in the form ephemeralX where X is a number starting from zero (0), for example,
ephemeral0
.- Returns:
- The name of the instance store volume (virtual device) to attach to an instance at launch. The name must
be in the form ephemeralX where X is a number starting from zero (0), for example,
ephemeral0
.
-
deviceName
The device name assigned to the volume (for example,
/dev/sdh
orxvdh
). For more information, see Device naming on Linux instances in the Amazon EC2 User Guide for Linux Instances.To define a block device mapping, set the device name and exactly one of the following properties:
Ebs
,NoDevice
, orVirtualName
.- Returns:
- The device name assigned to the volume (for example,
/dev/sdh
orxvdh
). For more information, see Device naming on Linux instances in the Amazon EC2 User Guide for Linux Instances.To define a block device mapping, set the device name and exactly one of the following properties:
Ebs
,NoDevice
, orVirtualName
.
-
ebs
Information to attach an EBS volume to an instance at launch.
- Returns:
- Information to attach an EBS volume to an instance at launch.
-
noDevice
Setting this value to
true
prevents a volume that is included in the block device mapping of the AMI from being mapped to the specified device name at launch.If
NoDevice
istrue
for the root device, instances might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.- Returns:
- Setting this value to
true
prevents a volume that is included in the block device mapping of the AMI from being mapped to the specified device name at launch.If
NoDevice
istrue
for the root device, instances might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.
-
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<BlockDeviceMapping.Builder,
BlockDeviceMapping> - 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
-