Class: Aws::AutoScaling::Types::BlockDeviceMapping

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Note:

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

{
  virtual_name: "XmlStringMaxLen255",
  device_name: "XmlStringMaxLen255", # required
  ebs: {
    snapshot_id: "XmlStringMaxLen255",
    volume_size: 1,
    volume_type: "BlockDeviceEbsVolumeType",
    delete_on_termination: false,
    iops: 1,
    encrypted: false,
  },
  no_device: false,
}

Describes a block device mapping.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#device_nameString

The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). For more information, see Device Naming on Linux Instances in the Amazon EC2 User Guide for Linux Instances.

Returns:

  • (String)


698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 698

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

#ebsTypes::Ebs

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

You can specify either VirtualName or Ebs, but not both.

Returns:



698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 698

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

#no_deviceBoolean

Setting this value to true suppresses the specified device included in the block device mapping of the AMI.

If NoDevice is true for the root device, instances might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.

If you specify NoDevice, you cannot specify Ebs.

Returns:

  • (Boolean)


698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 698

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

#virtual_nameString

The name of the virtual device (for example, ephemeral0).

You can specify either VirtualName or Ebs, but not both.

Returns:

  • (String)


698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 698

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