class BlockDeviceVolume

Language	Type name
.NET	Amazon.CDK.AWS.AutoScaling.BlockDeviceVolume
Java	software.amazon.awscdk.services.autoscaling.BlockDeviceVolume
Python	aws_cdk.aws_autoscaling.BlockDeviceVolume
TypeScript (source)	@aws-cdk/aws-autoscaling » BlockDeviceVolume

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as autoscaling from '@aws-cdk/aws-autoscaling';
const blockDeviceVolume = autoscaling.BlockDeviceVolume.ebs(123, /* all optional props */ {
  deleteOnTermination: false,
  encrypted: false,
  iops: 123,
  volumeType: autoscaling.EbsDeviceVolumeType.STANDARD,
});

Initializer (protected)

super(ebsDevice?: EbsDeviceProps, virtualName?: string)

Parameters

• ebsDevice EbsDeviceProps — EBS device info.
• virtualName string — Virtual device name.

Properties

Name	Type	Description
ebsDevice?	EbsDeviceProps	EBS device info.
virtualName?	string	Virtual device name.

---

ebsDevice?

Type: EbsDeviceProps (optional)

EBS device info.

---

virtualName?

Type: string (optional)

Virtual device name.

Methods

Name	Description
static ebs(volumeSize, options?)	Creates a new Elastic Block Storage device.
static ebsFromSnapshot(snapshotId, options?)	Creates a new Elastic Block Storage device from an existing snapshot.
static ephemeral(volumeIndex)	Creates a virtual, ephemeral device.
static noDevice()	Supresses a volume mapping.

---

static ebs(volumeSize, options?)

public static ebs(volumeSize: number, options?: EbsDeviceOptions): BlockDeviceVolume

Parameters

• volumeSize number — The volume size, in Gibibytes (GiB).
• options EbsDeviceOptions — additional device options.

Returns

• BlockDeviceVolume

Creates a new Elastic Block Storage device.

---

static ebsFromSnapshot(snapshotId, options?)

public static ebsFromSnapshot(snapshotId: string, options?: EbsDeviceSnapshotOptions): BlockDeviceVolume

Parameters

• snapshotId string — The snapshot ID of the volume to use.
• options EbsDeviceSnapshotOptions — additional device options.

Returns

• BlockDeviceVolume

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

---

static ephemeral(volumeIndex)

public static ephemeral(volumeIndex: number): BlockDeviceVolume

Parameters

• volumeIndex number — the volume index.

Returns

• BlockDeviceVolume

Creates a virtual, ephemeral device.

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

---

static noDevice()

public static noDevice(): BlockDeviceVolume

Returns

• BlockDeviceVolume

Supresses a volume mapping.