Class BlockDeviceVolume

Describes a block device mapping for an EC2 instance or Auto Scaling group.

Inheritance

object

BlockDeviceVolume

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class BlockDeviceVolume : DeputyBase

Syntax (vb)

Public Class BlockDeviceVolume Inherits DeputyBase

Remarks

ExampleMetadata: infused

Examples

Vpc vpc;
            InstanceType instanceType;
            IMachineImage machineImage;


            new Instance(this, "Instance", new InstanceProps {
                Vpc = vpc,
                InstanceType = instanceType,
                MachineImage = machineImage,

                // ...

                BlockDevices = new [] { new BlockDevice {
                    DeviceName = "/dev/sda1",
                    Volume = BlockDeviceVolume.Ebs(50)
                }, new BlockDevice {
                    DeviceName = "/dev/sdm",
                    Volume = BlockDeviceVolume.Ebs(100)
                } }
            });

Synopsis

Constructors

BlockDeviceVolume(IEbsDeviceProps?, string?)

Describes a block device mapping for an EC2 instance or Auto Scaling group.

Properties

EbsDevice	EBS device info.
VirtualName	Virtual device name.

Methods

Ebs(double, IEbsDeviceOptions?)	Creates a new Elastic Block Storage device.
EbsFromSnapshot(string, IEbsDeviceSnapshotOptions?)	Creates a new Elastic Block Storage device from an existing snapshot.
Ephemeral(double)	Creates a virtual, ephemeral device.

Constructors

BlockDeviceVolume(IEbsDeviceProps?, string?)

Describes a block device mapping for an EC2 instance or Auto Scaling group.

public BlockDeviceVolume(IEbsDeviceProps? ebsDevice = null, string? virtualName = null)

Parameters

ebsDevice IEbsDeviceProps

EBS device info.

virtualName string

Virtual device name.

Remarks

ExampleMetadata: infused

Properties

EbsDevice

EBS device info.

public virtual IEbsDeviceProps? EbsDevice { get; }

Property Value

IEbsDeviceProps

Remarks

ExampleMetadata: infused

VirtualName

Virtual device name.

public virtual string? VirtualName { get; }

Property Value

string

Remarks

ExampleMetadata: infused

Methods

Ebs(double, IEbsDeviceOptions?)

Creates a new Elastic Block Storage device.

public static BlockDeviceVolume Ebs(double volumeSize, IEbsDeviceOptions? options = null)

Parameters

volumeSize double

The volume size, in Gibibytes (GiB).

options IEbsDeviceOptions

additional device options.

Returns

BlockDeviceVolume

Remarks

ExampleMetadata: infused

EbsFromSnapshot(string, IEbsDeviceSnapshotOptions?)

Creates a new Elastic Block Storage device from an existing snapshot.

public static BlockDeviceVolume EbsFromSnapshot(string snapshotId, IEbsDeviceSnapshotOptions? options = null)

Parameters

snapshotId string

The snapshot ID of the volume to use.

options IEbsDeviceSnapshotOptions

additional device options.

Returns

BlockDeviceVolume

Remarks

ExampleMetadata: infused

Ephemeral(double)

Creates a virtual, ephemeral device.

public static BlockDeviceVolume Ephemeral(double volumeIndex)

Parameters

volumeIndex double

the volume index.

Returns

BlockDeviceVolume

Remarks

The name will be in the form ephemeral{volumeIndex}.