interface EbsDeviceOptionsBase
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EC2.EbsDeviceOptionsBase |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#EbsDeviceOptionsBase |
![]() | software.amazon.awscdk.services.ec2.EbsDeviceOptionsBase |
![]() | aws_cdk.aws_ec2.EbsDeviceOptionsBase |
![]() | aws-cdk-lib » aws_ec2 » EbsDeviceOptionsBase |
Base block device options for an EBS volume.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const ebsDeviceOptionsBase: ec2.EbsDeviceOptionsBase = {
deleteOnTermination: false,
iops: 123,
throughput: 123,
volumeType: ec2.EbsDeviceVolumeType.STANDARD,
};
Properties
Name | Type | Description |
---|---|---|
delete | boolean | Indicates whether to delete the volume when the instance is terminated. |
iops? | number | The number of I/O operations per second (IOPS) to provision for the volume. |
throughput? | number | The throughput to provision for a gp3 volume. |
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.
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.)
The throughput to provision for a gp3
volume.
Valid Range: Minimum value of 125. Maximum value of 1000.
gp3
volumes deliver a consistent baseline throughput performance of 125 MiB/s.
You can provision additional throughput for an additional cost at a ratio of 0.25 MiB/s per provisioned IOPS.
volumeType?
Type:
Ebs
(optional, default: EbsDeviceVolumeType.GENERAL_PURPOSE_SSD
or EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3
if
@aws-cdk/aws-ec2:ebsDefaultGp3Volume
is enabled.)
The EBS volume type.
See also: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html