aws-cdk-lib.aws_ec2.EbsDeviceSnapshotOptions

interface EbsDeviceSnapshotOptions

LanguageType name
.NETAmazon.CDK.AWS.EC2.EbsDeviceSnapshotOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#EbsDeviceSnapshotOptions
Javasoftware.amazon.awscdk.services.ec2.EbsDeviceSnapshotOptions
Pythonaws_cdk.aws_ec2.EbsDeviceSnapshotOptions
TypeScript (source)aws-cdk-lib » aws_ec2 » EbsDeviceSnapshotOptions

Block device options for an EBS volume created from a snapshot.

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 ebsDeviceSnapshotOptions: ec2.EbsDeviceSnapshotOptions = {
  deleteOnTermination: false,
  iops: 123,
  volumeSize: 123,
  volumeType: ec2.EbsDeviceVolumeType.STANDARD,
};

Properties

NameTypeDescription
deleteOnTermination?booleanIndicates whether to delete the volume when the instance is terminated.
iops?numberThe number of I/O operations per second (IOPS) to provision for the volume.
volumeSize?numberThe volume size, in Gibibytes (GiB).
volumeType?EbsDeviceVolumeTypeThe 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


volumeSize?

Type: number (optional, default: The snapshot size)

The volume size, in Gibibytes (GiB).

If you specify volumeSize, it must be equal or greater than the size of the snapshot.


volumeType?

Type: EbsDeviceVolumeType (optional, default: EbsDeviceVolumeType.GP2)

The EBS volume type.

See also: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html