interface EbsDeviceOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AutoScaling.EbsDeviceOptions |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsautoscaling#EbsDeviceOptions |
![]() | software.amazon.awscdk.services.autoscaling.EbsDeviceOptions |
![]() | aws_cdk.aws_autoscaling.EbsDeviceOptions |
![]() | aws-cdk-lib » aws_autoscaling » EbsDeviceOptions |
Block device options for an EBS volume.
Example
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
Name | Type | Description |
---|---|---|
delete | boolean | Indicates whether to delete the volume when the instance is terminated. |
encrypted? | boolean | Specifies whether the EBS volume is encrypted. |
iops? | number | The number of I/O operations per second (IOPS) to provision for the volume. |
throughput? | number | The throughput that the volume supports, in MiB/s Takes a minimum of 125 and maximum of 1000. |
volume | Ebs | The EBS volume type. |
deleteOnTermination?
Type:
boolean
(optional, default: true for Amazon EC2 Auto Scaling, false otherwise (e.g. EBS))
Indicates whether to delete the volume when the instance is terminated.
encrypted?
Type:
boolean
(optional, default: false)
Specifies whether the EBS volume is encrypted.
Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption
iops?
Type:
number
(optional, default: none, required for EbsDeviceVolumeType.IO1
)
The number of I/O operations per second (IOPS) to provision for the volume.
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.
See also: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
throughput?
Type:
number
(optional, default: 125 MiB/s. Only valid on gp3 volumes.)
The throughput that the volume supports, in MiB/s Takes a minimum of 125 and maximum of 1000.
See also: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
volumeType?
Type:
Ebs
(optional, default: EbsDeviceVolumeType.GP2
)
The EBS volume type.
See also: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html