interface BlockDeviceProperty

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

BlockDevice is a property of the EBS property of the AWS::AutoScaling::LaunchConfiguration BlockDeviceMapping property type that describes an Amazon EBS volume.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';
const blockDeviceProperty: autoscaling.CfnLaunchConfiguration.BlockDeviceProperty = {
  deleteOnTermination: false,
  encrypted: false,
  iops: 123,
  snapshotId: 'snapshotId',
  throughput: 123,
  volumeSize: 123,
  volumeType: 'volumeType',
};

Properties

Name	Type	Description
deleteOnTermination?	`boolean \|` `IResolvable`	Indicates whether the volume is deleted on instance termination.
encrypted?	`boolean \|` `IResolvable`	Specifies whether the volume should be encrypted.
iops?	`number`	The number of input/output (I/O) operations per second (IOPS) to provision for the volume.
snapshotId?	`string`	The snapshot ID of the volume to use.
throughput?	`number`	The throughput (MiBps) to provision for a `gp3` volume.
volumeSize?	`number`	The volume size, in GiBs. The following are the supported volumes sizes for each volume type:.
volumeType?	`string`	The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide .

deleteOnTermination?

Type: boolean | IResolvable (optional)

Indicates whether the volume is deleted on instance termination.

For Amazon EC2 Auto Scaling, the default value is true .

encrypted?

Type: boolean | IResolvable (optional)

Specifies whether the volume should be encrypted.

Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Requirements for Amazon EBS encryption in the Amazon EBS User Guide . If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.

If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the AWS managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.

For more information, see Use AWS KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide .

iops?

Type: number (optional)

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

For gp3 and io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

The following are the supported values for each volume type:

gp3 : 3,000-16,000 IOPS
io1 : 100-64,000 IOPS

For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.

Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1 . (Not used with standard , gp2 , st1 , or sc1 volumes.)

snapshotId?

Type: string (optional)

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId .

throughput?

Type: number (optional)

The throughput (MiBps) to provision for a gp3 volume.

volumeSize?

Type: number (optional)

The volume size, in GiBs. The following are the supported volumes sizes for each volume type:.

gp2 and gp3 : 1-16,384
io1 : 4-16,384
st1 and sc1 : 125-16,384
standard : 1-1,024

You must specify either a SnapshotId or a VolumeSize . If you specify both SnapshotId and VolumeSize , the volume size must be equal or greater than the size of the snapshot.

volumeType?

Type: string (optional)

The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide .

Valid values: standard | io1 | gp2 | st1 | sc1 | gp3