interface EbsDeviceOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EC2.EbsDeviceOptions |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#EbsDeviceOptions |
![]() | software.amazon.awscdk.services.ec2.EbsDeviceOptions |
![]() | aws_cdk.aws_ec2.EbsDeviceOptions |
![]() | aws-cdk-lib » aws_ec2 » EbsDeviceOptions |
Block device options for an EBS volume.
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,
}),
},
],
});
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. |
kms | IKey | The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption. |
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.
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
kmsKey?
Type:
IKey
(optional, default: If encrypted is true, the default aws/ebs KMS key will be used.)
The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
You have to ensure that the KMS CMK has the correct permissions to be used by the service launching the ec2 instances.
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