Package software.amazon.awscdk.mixins.preview.services.ec2.mixins

Interface CfnVolumeMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVolumeMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:25.530Z")
@Stability(Stable)
public interface CfnVolumeMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnVolumePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.services.ec2.mixins.*;
 CfnVolumeMixinProps cfnVolumeMixinProps = CfnVolumeMixinProps.builder()
         .autoEnableIo(false)
         .availabilityZone("availabilityZone")
         .availabilityZoneId("availabilityZoneId")
         .encrypted(false)
         .iops(123)
         .kmsKeyId("kmsKeyId")
         .multiAttachEnabled(false)
         .outpostArn("outpostArn")
         .size(123)
         .snapshotId("snapshotId")
         .sourceVolumeId("sourceVolumeId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .throughput(123)
         .volumeInitializationRate(123)
         .volumeType("volumeType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVolumeMixinProps.Builder	A builder for CfnVolumeMixinProps
static final class	CfnVolumeMixinProps.Jsii$Proxy	An implementation for CfnVolumeMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnVolumeMixinProps.Builder	builder()
default Object	getAutoEnableIo()	Indicates whether the volume is auto-enabled for I/O operations.
default String	getAvailabilityZone()	The ID of the Availability Zone in which to create the volume.
default String	getAvailabilityZoneId()	The ID of the Availability Zone in which to create the volume.
default Object	getEncrypted()	Indicates whether the volume should be encrypted.
default Number	getIops()	The number of I/O operations per second (IOPS) to provision for the volume.
default String	getKmsKeyId()	The identifier of the AWS KMS key to use for Amazon EBS encryption.
default Object	getMultiAttachEnabled()	Indicates whether Amazon EBS Multi-Attach is enabled.
default String	getOutpostArn()	The Amazon Resource Name (ARN) of the Outpost on which to create the volume.
default Number	getSize()	The size of the volume, in GiBs.
default String	getSnapshotId()	The snapshot from which to create the volume.
default String	getSourceVolumeId()	The ID of the source EBS volume to copy.
default List<CfnTag>	getTags()	The tags to apply to the volume during creation.
default Number	getThroughput()	The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
default Number	getVolumeInitializationRate()	Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume.
default String	getVolumeType()	The volume type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutoEnableIo

@Stability(Stable)
@Nullable
default Object getAutoEnableIo()

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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-autoenableio

getAvailabilityZone

@Stability(Stable)
@Nullable
default String getAvailabilityZone()

The ID of the Availability Zone in which to create the volume. For example, us-east-1a .

Either AvailabilityZone or AvailabilityZoneId must be specified, but not both.

If you are creating a volume copy, omit this parameter. The volume copy is created in the same Availability Zone as the source volume.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzone

getAvailabilityZoneId

@Stability(Stable)
@Nullable
default String getAvailabilityZoneId()

The ID of the Availability Zone in which to create the volume. For example, use1-az1 .

Either AvailabilityZone or AvailabilityZoneId must be specified, but not both.

If you are creating a volume copy, omit this parameter. The volume copy is created in the same Availability Zone as the source volume.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzoneid

getEncrypted

@Stability(Stable)
@Nullable
default Object getEncrypted()

Indicates whether the volume should be encrypted.

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

If you are creating a volume copy, omit this parameter. The volume is automatically encrypted with the same KMS key as the source volume. You can't copy unencrypted volumes.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-encrypted

getIops

@Stability(Stable)
@Nullable
default Number getIops()

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

Required for io1 and io2 volumes. Optional for gp3 volumes. Omit for all other volume types.

Valid ranges:

• gp3: 3,000 ( default ) - 80,000 IOPS
• io1: 100 - 64,000 IOPS
• io2: 100 - 256,000 IOPS

Instances built on the Nitro System can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-iops

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

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.

If you are creating a volume copy, omit this parameter. The volume is automatically encrypted with the same KMS key as the source volume. You can't copy unencrypted volumes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-kmskeyid

getMultiAttachEnabled

@Stability(Stable)
@Nullable
default Object getMultiAttachEnabled()

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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-multiattachenabled

getOutpostArn

@Stability(Stable)
@Nullable
default String getOutpostArn()

The Amazon Resource Name (ARN) of the Outpost on which to create the volume.

If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an AWS Region with an instance on an AWS outpost, or the other way around.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-outpostarn

getSize

@Stability(Stable)
@Nullable
default Number getSize()

The size of the volume, in GiBs.

• Required for new empty volumes.
• Optional for volumes created from snapshots and volume copies. In this case, the size defaults to the size of the snapshot or source volume. You can optionally specify a size that is equal to or larger than the size of the source snapshot or volume.

Supported volume sizes:

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-size

getSnapshotId

@Stability(Stable)
@Nullable
default String getSnapshotId()

The snapshot from which to create the volume.

Only specify to create a volume from a snapshot. To create a new empty volume, omit this parameter and specify a value for Size instead. To create a volume copy, omit this parameter and specify SourceVolumeId instead.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-snapshotid

getSourceVolumeId

@Stability(Stable)
@Nullable
default String getSourceVolumeId()

The ID of the source EBS volume to copy.

When specified, the volume is created as an exact copy of the specified volume. Only specify to create a volume copy. To create a new empty volume or to create a volume from a snapshot, omit this parameter,

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-sourcevolumeid

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to apply to the volume during creation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-tags

getThroughput

@Stability(Stable)
@Nullable
default Number getThroughput()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-throughput

getVolumeInitializationRate

@Stability(Stable)
@Nullable
default Number getVolumeInitializationRate()

Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume.

This is also known as volume initialization . Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.

This parameter is supported only for volumes created from snapshots. Omit this parameter if:

• You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.

If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.

• You want to create a volume that is initialized at the default rate.

For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide .

Valid range: 100 - 300 MiB/s

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumeinitializationrate

getVolumeType

@Stability(Stable)
@Nullable
default String getVolumeType()

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

Throughput Optimized HDD ( st1 ) and Cold HDD ( sc1 ) volumes can't be used as boot volumes.

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

Default: gp2

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumetype

builder

@Stability(Stable)
static CfnVolumeMixinProps.Builder builder()

Returns:

a CfnVolumeMixinProps.Builder of CfnVolumeMixinProps