Class: Aws::EC2::Types::BlockDeviceMapping

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::BlockDeviceMapping

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass BlockDeviceMapping data as a hash:

{
  device_name: "String",
  virtual_name: "String",
  ebs: {
    delete_on_termination: false,
    iops: 1,
    snapshot_id: "SnapshotId",
    volume_size: 1,
    volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
    kms_key_id: "String",
    throughput: 1,
    outpost_arn: "String",
    encrypted: false,
  },
  no_device: "String",
}

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #device_name ⇒ String

  The device name (for example, /dev/sdh or xvdh).

• #ebs ⇒ Types::EbsBlockDevice

  Parameters used to automatically set up EBS volumes when the instance is launched.

• #no_device ⇒ String

  To omit the device from the block device mapping, specify an empty string.

• #virtual_name ⇒ String

  The virtual device name (ephemeralN).

Instance Attribute Details

#device_name ⇒ String

The device name (for example, /dev/sdh or xvdh).

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3118

class BlockDeviceMapping < Struct.new(
  :device_name,
  :virtual_name,
  :ebs,
  :no_device)
  SENSITIVE = []
  include Aws::Structure
end

#ebs ⇒ Types::EbsBlockDevice

Parameters used to automatically set up EBS volumes when the instance is launched.

Returns:

• (Types::EbsBlockDevice)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3118

class BlockDeviceMapping < Struct.new(
  :device_name,
  :virtual_name,
  :ebs,
  :no_device)
  SENSITIVE = []
  include Aws::Structure
end

#no_device ⇒ String

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:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3118

class BlockDeviceMapping < Struct.new(
  :device_name,
  :virtual_name,
  :ebs,
  :no_device)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_name ⇒ String

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:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3118

class BlockDeviceMapping < Struct.new(
  :device_name,
  :virtual_name,
  :ebs,
  :no_device)
  SENSITIVE = []
  include Aws::Structure
end