# EbsDeviceProps

Properties of an EBS block device.

Extends: EbsDeviceProps
Extends: EbsDeviceSnapshotOptions
Used as props by: BlockDeviceVolume

- Source: [`aws-autoscaling/lib/volume.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-autoscaling/lib/volume.ts#L127)

## Example

```ts
// 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 ebsDeviceProps: autoscaling.EbsDeviceProps = {
  deleteOnTermination: false,
  iops: 123,
  snapshotId: 'snapshotId',
  throughput: 123,
  volumeInitializationRate: size,
  volumeSize: 123,
  volumeType: autoscaling.EbsDeviceVolumeType.STANDARD,
};
```

## Properties

- `deleteOnTermination`: boolean — Indicates whether to delete the volume when the instance is terminated.

  **Default:** true for Amazon EC2 Auto Scaling, false otherwise (e.g. EBS)

- `iops`: number — The number of I/O operations per second (IOPS) to provision for the volume.

  **Default:** none, required for `EbsDeviceVolumeType.IO1`

  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.

- `snapshotId`: string — The snapshot ID of the volume to use.

  **Default:** No snapshot will be used

- `throughput`: number — The throughput that the volume supports, in MiB/s Takes a minimum of 125 and maximum of 2000.

  **Default:** 125 MiB/s. Only valid on gp3 volumes.

- `volumeInitializationRate`: [Size](/cdk/api/v2/docs/aws-cdk-lib.Size.html) — The Amazon EBS Provisioned Rate for Volume Initialization, at which to download the snapshot blocks from Amazon S3 to the volume.

  **Default:** undefined - The volume initialization rate is not set.

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

- `volumeSize`: number — The volume size, in Gibibytes (GiB).

  **Default:** The snapshot size

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

- `volumeType`: [EbsDeviceVolumeType](/cdk/api/v2/docs/aws-cdk-lib.aws_autoscaling.EbsDeviceVolumeType.html) = `EbsDeviceVolumeType.GP2` — The EBS volume type.