interface CfnVolumeProps

Language	Type name
.NET	`Amazon.CDK.AWS.EC2.CfnVolumeProps`
Java	`software.amazon.awscdk.services.ec2.CfnVolumeProps`
Python	`aws_cdk.aws_ec2.CfnVolumeProps`
TypeScript	`@aws-cdk/aws-ec2` » `CfnVolumeProps`

Properties for defining a CfnVolume.

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 cfnVolumeProps: ec2.CfnVolumeProps = {
  availabilityZone: 'availabilityZone',

  // the properties below are optional
  autoEnableIo: false,
  encrypted: false,
  iops: 123,
  kmsKeyId: 'kmsKeyId',
  multiAttachEnabled: false,
  outpostArn: 'outpostArn',
  size: 123,
  snapshotId: 'snapshotId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  throughput: 123,
  volumeType: 'volumeType',
};

Properties

Name	Type	Description
availabilityZone	`string`	The ID of the Availability Zone in which to create the volume.
autoEnableIo?	`boolean \|` `IResolvable`	Indicates whether the volume is auto-enabled for I/O operations.
encrypted?	`boolean \|` `IResolvable`	Indicates whether the volume should be encrypted.
iops?	`number`	The number of I/O operations per second (IOPS).
kmsKeyId?	`string`	The identifier of the AWS KMS key to use for Amazon EBS encryption.
multiAttachEnabled?	`boolean \|` `IResolvable`	Indicates whether Amazon EBS Multi-Attach is enabled.
outpostArn?	`string`	The Amazon Resource Name (ARN) of the Outpost.
size?	`number`	The size of the volume, in GiBs.
snapshotId?	`string`	The snapshot from which to create the volume.
tags?	`CfnTag[]`	The tags to apply to the volume during creation.
throughput?	`number`	The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
volumeType?	`string`	The volume type. This parameter can be one of the following values:.

availabilityZone

Type: string

The ID of the Availability Zone in which to create the volume.

For example, us-east-1a .

autoEnableIo?

Type: boolean | IResolvable (optional)

Indicates whether the volume is auto-enabled for I/O operations.

By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.

encrypted?

Type: boolean | IResolvable (optional)

Indicates whether the volume should be encrypted.

The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide .

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .

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

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

This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.

kmsKeyId?

Type: string (optional)

The identifier of the AWS KMS key to use for Amazon EBS encryption.

If KmsKeyId is specified, the encrypted state must be true .

If you omit this property and your account is enabled for encryption by default, or Encrypted is set to true , then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the AWS managed key .

Alternatively, if you want to specify a different key, you can specify one of the following:

Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. Specify the alias for the key, prefixed with alias/ . For example, for a key with the alias my_cmk , use alias/my_cmk . Or to specify the AWS managed key , use alias/aws/ebs .
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

multiAttachEnabled?

Type: boolean | IResolvable (optional)

Indicates whether Amazon EBS Multi-Attach is enabled.

AWS CloudFormation does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.

outpostArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Outpost.

size?

Type: number (optional)

The size of the volume, in GiBs.

You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot 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

snapshotId?

Type: string (optional)

The snapshot from which to create the volume.

You must specify either a snapshot ID or a volume size.

tags?

Type: CfnTag[] (optional)

The tags to apply to the volume during creation.

throughput?

Type: number (optional)

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

This parameter is valid only for gp3 volumes. The default value is 125.

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

volumeType?

Type: string (optional)

The volume type. This parameter can be one of the following values:.

General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard

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

Default: gp2