interface EbsDeviceOptions

Language	Type name
.NET	`Amazon.CDK.AWS.AutoScaling.EbsDeviceOptions`
Java	`software.amazon.awscdk.services.autoscaling.EbsDeviceOptions`
Python	`aws_cdk.aws_autoscaling.EbsDeviceOptions`
TypeScript (source)	`@aws-cdk/aws-autoscaling` » `EbsDeviceOptions`

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 * as autoscaling from '@aws-cdk/aws-autoscaling';
const ebsDeviceOptions: autoscaling.EbsDeviceOptions = {
  deleteOnTermination: false,
  encrypted: false,
  iops: 123,
  volumeType: autoscaling.EbsDeviceVolumeType.STANDARD,
};

Properties

Name	Type	Description
deleteOnTermination?	`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.
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.

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 {@link EbsDeviceVolumeType.IO1})

The number of I/O operations per second (IOPS) to provision for the volume.

Must only be set for {@link volumeType}: {@link 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.

volumeType?

Type: EbsDeviceVolumeType (optional, default: {@link EbsDeviceVolumeType.GP2})

The EBS volume type.