interface EbsDeviceSnapshotOptions

Language	Type name
.NET	`Amazon.CDK.AWS.AutoScaling.EbsDeviceSnapshotOptions`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsautoscaling#EbsDeviceSnapshotOptions`
Java	`software.amazon.awscdk.services.autoscaling.EbsDeviceSnapshotOptions`
Python	`aws_cdk.aws_autoscaling.EbsDeviceSnapshotOptions`
TypeScript (source)	`aws-cdk-lib` » `aws_autoscaling` » `EbsDeviceSnapshotOptions`

Implements EbsDeviceOptionsBase

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 * as cdk from 'aws-cdk-lib';
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';

declare const size: cdk.Size;
const ebsDeviceSnapshotOptions: autoscaling.EbsDeviceSnapshotOptions = {
  deleteOnTermination: false,
  iops: 123,
  throughput: 123,
  volumeInitializationRate: size,
  volumeSize: 123,
  volumeType: autoscaling.EbsDeviceVolumeType.STANDARD,
};

Properties

Name	Type	Description
deleteOnTermination?	`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 that the volume supports, in MiB/s Takes a minimum of 125 and maximum of 2000.
volumeInitializationRate?	`Size`	The Amazon EBS Provisioned Rate for Volume Initialization, at which to download the snapshot blocks from Amazon S3 to the volume.
volumeSize?	`number`	The volume size, in Gibibytes (GiB).
volumeType?	`EbsDeviceVolumeType`	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.

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 2000.

volumeInitializationRate?

Type: Size (optional, default: undefined - The volume initialization rate is not set.)

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

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

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.

AWS CDK

2.265.0