1.204.0

interface EbsProperty

LanguageType name
.NETAmazon.CDK.AWS.EC2.CfnLaunchTemplate.EbsProperty
Javasoftware.amazon.awscdk.services.ec2.CfnLaunchTemplate.EbsProperty
Pythonaws_cdk.aws_ec2.CfnLaunchTemplate.EbsProperty
TypeScript @aws-cdk/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 * as ec2 from '@aws-cdk/aws-ec2';
const ebsProperty: ec2.CfnLaunchTemplate.EbsProperty = {
  deleteOnTermination: false,
  encrypted: false,
  iops: 123,
  kmsKeyId: 'kmsKeyId',
  snapshotId: 'snapshotId',
  throughput: 123,
  volumeSize: 123,
  volumeType: 'volumeType',
};

Properties

NameTypeDescription
deleteOnTermination?boolean | IResolvableIndicates whether the EBS volume is deleted on instance termination.
encrypted?boolean | IResolvableIndicates whether the EBS volume is encrypted.
iops?numberThe number of I/O operations per second (IOPS).
kmsKeyId?stringThe ARN of the symmetric AWS Key Management Service ( AWS KMS ) CMK used for encryption.
snapshotId?stringThe ID of the snapshot.
throughput?numberThe throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
volumeSize?numberThe size of the volume, in GiBs.
volumeType?stringThe 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-64,000 IOPS

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

This parameter is supported for io1 , io2 , and gp3 volumes only. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.

kmsKeyId?

Type: string (optional)

The ARN of the symmetric AWS Key Management Service ( AWS KMS ) CMK used for 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
  • io1 and io2 : 4-16,384
  • st1 and sc1 : 125-16,384
  • standard : 1-1,024

volumeType?

Type: string (optional)

The volume type.

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

← PreviousNext →