interface EbsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.EC2.CfnLaunchTemplate.EbsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnLaunchTemplate_EbsProperty`
Java	`software.amazon.awscdk.services.ec2.CfnLaunchTemplate.EbsProperty`
Python	`aws_cdk.aws_ec2.CfnLaunchTemplate.EbsProperty`
TypeScript	`aws-cdk-lib` » `aws_ec2` » `CfnLaunchTemplate` » `EbsProperty`

Parameters for a block device for an EBS volume in an Amazon EC2 launch template.

Ebs is a property of AWS::EC2::LaunchTemplate BlockDeviceMapping .

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 ebsProperty: ec2.CfnLaunchTemplate.EbsProperty = {
  deleteOnTermination: false,
  encrypted: false,
  iops: 123,
  kmsKeyId: 'kmsKeyId',
  snapshotId: 'snapshotId',
  throughput: 123,
  volumeSize: 123,
  volumeType: 'volumeType',
};

Properties

Name	Type	Description
deleteOnTermination?	`boolean \|` `IResolvable`	Indicates whether the EBS volume is deleted on instance termination.
encrypted?	`boolean \|` `IResolvable`	Indicates whether the EBS volume is encrypted.
iops?	`number`	The number of I/O operations per second (IOPS).
kmsKeyId?	`string`	Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.
snapshotId?	`string`	The ID of the snapshot.
throughput?	`number`	The throughput to provision for a `gp3` volume, with a maximum of 1,000 MiB/s.
volumeSize?	`number`	The size of the volume, in GiBs.
volumeType?	`string`	The volume type.

deleteOnTermination?

Type: boolean | IResolvable (optional)

Indicates whether the EBS volume is deleted on instance termination.

encrypted?

Type: boolean | IResolvable (optional)

Indicates whether the EBS volume is encrypted.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

iops?

Type: number (optional)

The number of I/O operations per second (IOPS).

For gp3 , io1 , and io2 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
io2 : 100 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System . On other instances, you can achieve performance up to 32,000 IOPS.

This parameter is supported for io1 , io2 , and gp3 volumes only.

kmsKeyId?

Type: string (optional)

Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.

snapshotId?

Type: string (optional)

The ID of the snapshot.

throughput?

Type: number (optional)

The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.

Valid Range: Minimum value of 125. Maximum value of 1000.

volumeSize?

Type: number (optional)

The size of the volume, in GiBs.

You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:

gp2 and gp3 : 1 - 16,384 GiB
io1 : 4 - 16,384 GiB
io2 : 4 - 65,536 GiB
st1 and sc1 : 125 - 16,384 GiB
standard : 1 - 1024 GiB

volumeType?

Type: string (optional)

The volume type.

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