You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
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: "String",
    volume_size: 1,
    volume_type: "standard", # accepts standard, io1, gp2, sc1, st1
    encrypted: false,
    kms_key_id: "String",
  },
  no_device: "String",
}

Describes a block device mapping.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#device_name ⇒ String

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

Returns:

  • (String) 


1871
1872
1873
1874
1875
1876
1877
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1871

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

#ebs ⇒ Types::EbsBlockDevice

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

Returns:



1871
1872
1873
1874
1875
1876
1877
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1871

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

#no_device ⇒ String

Suppresses the specified device included in the block device mapping of the AMI.

Returns:

  • (String) 


1871
1872
1873
1874
1875
1876
1877
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1871

class BlockDeviceMapping < Struct.new(
  :device_name,
  :virtual_name,
  :ebs,
  :no_device)
  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) 


1871
1872
1873
1874
1875
1876
1877
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1871

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