class BlockDeviceVolume
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EC2.BlockDeviceVolume |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#BlockDeviceVolume |
![]() | software.amazon.awscdk.services.ec2.BlockDeviceVolume |
![]() | aws_cdk.aws_ec2.BlockDeviceVolume |
![]() | aws-cdk-lib » aws_ec2 » BlockDeviceVolume |
Describes a block device mapping for an EC2 instance or Auto Scaling group.
Example
declare const vpc: ec2.Vpc;
declare const instanceType: ec2.InstanceType;
declare const machineImage: ec2.IMachineImage;
new ec2.Instance(this, 'Instance', {
vpc,
instanceType,
machineImage,
// ...
blockDevices: [
{
deviceName: '/dev/sda1',
volume: ec2.BlockDeviceVolume.ebs(100, {
volumeType: ec2.EbsDeviceVolumeType.GP3,
throughput: 250,
}),
},
],
});
Initializer (protected)
super(ebsDevice?: EbsDeviceProps, virtualName?: string)
Parameters
- ebsDevice
Ebs
— EBS device info.Device Props - virtualName
string
— Virtual device name.
Properties
Name | Type | Description |
---|---|---|
ebs | Ebs | EBS device info. |
virtual | string | Virtual device name. |
ebsDevice?
Type:
Ebs
(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 ebs | Creates a new Elastic Block Storage device from an existing snapshot. |
static ephemeral(volumeIndex) | Creates a virtual, ephemeral device. |
static ebs(volumeSize, options?)
public static ebs(volumeSize: number, options?: EbsDeviceOptions): BlockDeviceVolume
Parameters
- volumeSize
number
— The volume size, in Gibibytes (GiB). - options
Ebs
— additional device options.Device Options
Returns
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
Ebs
— additional device options.Device Snapshot Options
Returns
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
Creates a virtual, ephemeral device.
The name will be in the form ephemeral{volumeIndex}.