BlockDeviceVolume Class
Describes a block device mapping for an EC2 instance or Auto Scaling group.
| Source | aws-ec2/lib/volume.ts |
|---|
Example
ts
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(50),
},
{
deviceName: '/dev/sdm',
volume: ec2.BlockDeviceVolume.ebs(100),
},
],
});
python
# vpc: ec2.Vpc
# instance_type: ec2.InstanceType
# machine_image: ec2.IMachineImage
ec2.Instance(self, "Instance",
vpc=vpc,
instance_type=instance_type,
machine_image=machine_image,
# ...
block_devices=[ec2.BlockDevice(
device_name="/dev/sda1",
volume=ec2.BlockDeviceVolume.ebs(50)
), ec2.BlockDevice(
device_name="/dev/sdm",
volume=ec2.BlockDeviceVolume.ebs(100)
)
]
)
java
Vpc vpc;
InstanceType instanceType;
IMachineImage machineImage;
Instance.Builder.create(this, "Instance")
.vpc(vpc)
.instanceType(instanceType)
.machineImage(machineImage)
// ...
.blockDevices(List.of(BlockDevice.builder()
.deviceName("/dev/sda1")
.volume(BlockDeviceVolume.ebs(50))
.build(), BlockDevice.builder()
.deviceName("/dev/sdm")
.volume(BlockDeviceVolume.ebs(100))
.build()))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
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)
} }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var vpc Vpc
var instanceType InstanceType
var machineImage IMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// ...
BlockDevices: []BlockDevice{
&BlockDevice{
DeviceName: jsii.String("/dev/sda1"),
Volume: ec2.BlockDeviceVolume_Ebs(jsii.Number(50)),
},
&BlockDevice{
DeviceName: jsii.String("/dev/sdm"),
Volume: ec2.BlockDeviceVolume_*Ebs(jsii.Number(100)),
},
},
})
Properties
ebsDevicemay be undefinedEbsDevicePropsebs_devicemay be undefinedEbsDevicePropsebsDevicemay be undefinedEbsDevicePropsEbsDevicemay be undefinedEbsDevicePropsEbsDevicemay be undefinedEbsDeviceProps #EBS device info.
virtualNamemay be undefinedstringvirtual_namemay be undefinedstrvirtualNamemay be undefinedStringVirtualNamemay be undefinedstringVirtualNamemay be undefined*string #Virtual device name.
Methods
ebs(volumeSize: number, options?: EbsDeviceOptions): BlockDeviceVolume // chainable@staticmethod def ebs(volume_size: int | float, options: typing.Optional[EbsDeviceOptions] = None) -> BlockDeviceVolumepublic static BlockDeviceVolume ebs(Number volumeSize, EbsDeviceOptions options)public static BlockDeviceVolume Ebs(double volumeSize, EbsDeviceOptions? options = null)func Ebs(VolumeSize *float64, Options EbsDeviceOptions) BlockDeviceVolume static #Creates a new Elastic Block Storage device.
2 parameters
Parameters
volumeSizevolume_sizevolumeSizevolumeSizeVolumeSize— The volume size, in Gibibytes (GiB).optionsoptionsoptionsoptionsOptions— additional device options.
ebsFromSnapshot(snapshotId: string, options?: EbsDeviceSnapshotOptions): BlockDeviceVolume // chainable@staticmethod def ebs_from_snapshot(snapshot_id: str, options: typing.Optional[EbsDeviceSnapshotOptions] = None) -> BlockDeviceVolumepublic static BlockDeviceVolume ebsFromSnapshot(String snapshotId, EbsDeviceSnapshotOptions options)public static BlockDeviceVolume EbsFromSnapshot(string snapshotId, EbsDeviceSnapshotOptions? options = null)func EbsFromSnapshot(SnapshotId *string, Options EbsDeviceSnapshotOptions) BlockDeviceVolume static #Creates a new Elastic Block Storage device from an existing snapshot.
2 parameters
Parameters
snapshotIdsnapshot_idsnapshotIdsnapshotIdSnapshotId— The snapshot ID of the volume to use.optionsoptionsoptionsoptionsOptions— additional device options.
ephemeral(volumeIndex: number): BlockDeviceVolume // chainable@staticmethod def ephemeral(volume_index: int | float) -> BlockDeviceVolumepublic static BlockDeviceVolume ephemeral(Number volumeIndex)public static BlockDeviceVolume Ephemeral(double volumeIndex)func Ephemeral(VolumeIndex *float64) BlockDeviceVolume static #Creates a virtual, ephemeral device.
The name will be in the form ephemeral{volumeIndex}.
1 parameter
Parameters
volumeIndexvolume_indexvolumeIndexvolumeIndexVolumeIndex— the volume index.