Class BlockDeviceMapping
- java.lang.Object
-
- software.amazon.awssdk.services.autoscaling.model.BlockDeviceMapping
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BlockDeviceMapping.Builder,BlockDeviceMapping>
@Generated("software.amazon.awssdk:codegen") public final class BlockDeviceMapping extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BlockDeviceMapping.Builder,BlockDeviceMapping>
Describes a block device mapping.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
BlockDeviceMapping.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static BlockDeviceMapping.Builder
builder()
String
deviceName()
The device name assigned to the volume (for example,/dev/sdh
orxvdh
).Ebs
ebs()
Information to attach an EBS volume to an instance at launch.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
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.List<SdkField<?>>
sdkFields()
static Class<? extends BlockDeviceMapping.Builder>
serializableBuilderClass()
BlockDeviceMapping.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
virtualName()
The name of the instance store volume (virtual device) to attach to an instance at launch.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
virtualName
public final String 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
public final String 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
public final Ebs 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
public final Boolean 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
public BlockDeviceMapping.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<BlockDeviceMapping.Builder,BlockDeviceMapping>
-
builder
public static BlockDeviceMapping.Builder builder()
-
serializableBuilderClass
public static Class<? extends BlockDeviceMapping.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String 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.
-
-