BlockDeviceMapping (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ec2.model.BlockDeviceMapping

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BlockDeviceMapping
extends Object
implements Serializable, Cloneable
```
Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BlockDeviceMapping()

Constructors
Constructor and Description
`BlockDeviceMapping()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BlockDeviceMapping`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDeviceName()` The device name (for example, `/dev/sdh` or `xvdh`).
`EbsBlockDevice`	`getEbs()` Parameters used to automatically set up EBS volumes when the instance is launched.
`String`	`getNoDevice()` To omit the device from the block device mapping, specify an empty string.
`String`	`getVirtualName()` The virtual device name (`ephemeral`N).
`int`	`hashCode()`
`void`	`setDeviceName(String deviceName)` The device name (for example, `/dev/sdh` or `xvdh`).
`void`	`setEbs(EbsBlockDevice ebs)` Parameters used to automatically set up EBS volumes when the instance is launched.
`void`	`setNoDevice(String noDevice)` To omit the device from the block device mapping, specify an empty string.
`void`	`setVirtualName(String virtualName)` The virtual device name (`ephemeral`N).
`String`	`toString()` Returns a string representation of this object.
`BlockDeviceMapping`	`withDeviceName(String deviceName)` The device name (for example, `/dev/sdh` or `xvdh`).
`BlockDeviceMapping`	`withEbs(EbsBlockDevice ebs)` Parameters used to automatically set up EBS volumes when the instance is launched.
`BlockDeviceMapping`	`withNoDevice(String noDevice)` To omit the device from the block device mapping, specify an empty string.
`BlockDeviceMapping`	`withVirtualName(String virtualName)` The virtual device name (`ephemeral`N).

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BlockDeviceMapping
```
public BlockDeviceMapping()
```
- Method Detail
  - setDeviceName
```
public void setDeviceName(String deviceName)
```
    The device name (for example, /dev/sdh or xvdh).
    
    Parameters:
    
    deviceName - The device name (for example, /dev/sdh or xvdh).
  - getDeviceName
```
public String getDeviceName()
```
    The device name (for example, /dev/sdh or xvdh).
    
    Returns:
    
    The device name (for example, /dev/sdh or xvdh).
  - withDeviceName
```
public BlockDeviceMapping withDeviceName(String deviceName)
```
    The device name (for example, /dev/sdh or xvdh).
    
    Parameters:
    
    deviceName - The device name (for example, /dev/sdh or xvdh).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVirtualName
```
public void setVirtualName(String virtualName)
```
    The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
    
    NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
    
    Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
    
    Parameters:
    
    virtualName - The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
    
    NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
    
    Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
  - getVirtualName
```
public String getVirtualName()
```
    The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
    
    NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
    
    Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
    
    Returns:
    
    The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
    
    NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
    
    Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
  - withVirtualName
```
public BlockDeviceMapping withVirtualName(String virtualName)
```
    The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
    
    NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
    
    Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
    
    Parameters:
    
    virtualName - The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
    
    NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
    
    Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEbs
```
public void setEbs(EbsBlockDevice ebs)
```
    Parameters used to automatically set up EBS volumes when the instance is launched.
    
    Parameters:
    
    ebs - Parameters used to automatically set up EBS volumes when the instance is launched.
  - getEbs
```
public EbsBlockDevice getEbs()
```
    Parameters used to automatically set up EBS volumes when the instance is launched.
    
    Returns:
    
    Parameters used to automatically set up EBS volumes when the instance is launched.
  - withEbs
```
public BlockDeviceMapping withEbs(EbsBlockDevice ebs)
```
    Parameters used to automatically set up EBS volumes when the instance is launched.
    
    Parameters:
    
    ebs - Parameters used to automatically set up EBS volumes when the instance is launched.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNoDevice
```
public void setNoDevice(String noDevice)
```
    To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
    
    Parameters:
    
    noDevice - To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
  - getNoDevice
```
public String getNoDevice()
```
    To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
    
    Returns:
    
    To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
  - withNoDevice
```
public BlockDeviceMapping withNoDevice(String noDevice)
```
    To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
    
    Parameters:
    
    noDevice - To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BlockDeviceMapping clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.777

Class BlockDeviceMapping

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BlockDeviceMapping

Method Detail

setDeviceName

getDeviceName

withDeviceName

setVirtualName

getVirtualName

withVirtualName

setEbs

getEbs

withEbs

setNoDevice

getNoDevice

withNoDevice

toString

equals

hashCode

clone