Skip to content
v2.274.0

EbsDeviceOptions Struct ​

Block device options for an EBS volume.

Example ​

ts
declare const vpc: ec2.Vpc;
declare const instanceType: ec2.InstanceType;
declare const machineImage: ec2.IMachineImage;

const autoScalingGroup = new autoscaling.AutoScalingGroup(this, 'ASG', {
  vpc,
  instanceType,
  machineImage,
  blockDevices: [
    {
        deviceName: 'gp3-volume',
        volume: autoscaling.BlockDeviceVolume.ebs(15, {
          volumeType: autoscaling.EbsDeviceVolumeType.GP3,
          throughput: 125,
        }),
      },
  ],
  // ...
});

Properties ​

deleteOnTerminationoptionalbooleandelete_on_terminationoptionalbooldeleteOnTerminationoptionalBooleanDeleteOnTerminationoptionalboolDeleteOnTerminationoptional*bool#
Indicates whether to delete the volume when the instance is terminated.

Default: true for Amazon EC2 Auto Scaling, false otherwise (e.g. EBS)

encryptedoptionalbooleanencryptedoptionalboolencryptedoptionalBooleanEncryptedoptionalboolEncryptedoptional*bool= false#
Specifies whether the EBS volume is encrypted.

Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption

iopsoptionalnumberiopsoptionalint | floatiopsoptionalNumberIopsoptionaldoubleIopsoptional*float64#
The number of I/O operations per second (IOPS) to provision for the volume.

Default: none, required for EbsDeviceVolumeType.IO1

Must only be set for volumeType: EbsDeviceVolumeType.IO1

The maximum ratio of IOPS to volume size (in GiB) is 50:1, so for 5,000 provisioned IOPS, you need at least 100 GiB storage on the volume.

throughputoptionalnumberthroughputoptionalint | floatthroughputoptionalNumberThroughputoptionaldoubleThroughputoptional*float64#
The throughput that the volume supports, in MiB/s Takes a minimum of 125 and maximum of 2000.

Default: 125 MiB/s. Only valid on gp3 volumes.

volumeInitializationRateoptionalSizevolume_initialization_rateoptionalSizevolumeInitializationRateoptionalSizeVolumeInitializationRateoptionalSizeVolumeInitializationRateoptionalSize#
The Amazon EBS Provisioned Rate for Volume Initialization, at which to download the snapshot blocks from Amazon S3 to the volume.

Default: undefined - The volume initialization rate is not set.

Valid range is between 100 and 300 MiB/s. This parameter is supported only for volumes created from snapshots.

volumeTypeoptionalEbsDeviceVolumeTypevolume_typeoptionalEbsDeviceVolumeTypevolumeTypeoptionalEbsDeviceVolumeTypeVolumeTypeoptionalEbsDeviceVolumeTypeVolumeTypeoptionalEbsDeviceVolumeType= `EbsDeviceVolumeType.GP2`#
The EBS volume type.