Package software.amazon.awscdk.services.ec2

Interface CfnVolumeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVolumeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:06.082Z")
@Stability(Stable)
public interface CfnVolumeProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.ec2.*;
 CfnVolumeProps cfnVolumeProps = CfnVolumeProps.builder()
         .availabilityZone("availabilityZone")
         // the properties below are optional
         .autoEnableIo(false)
         .encrypted(false)
         .iops(123)
         .kmsKeyId("kmsKeyId")
         .multiAttachEnabled(false)
         .outpostArn("outpostArn")
         .size(123)
         .snapshotId("snapshotId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .throughput(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	CfnVolumeProps.Builder	A builder for CfnVolumeProps
static final class	CfnVolumeProps.Jsii$Proxy	An implementation for CfnVolumeProps

Method Summary

Modifier and Type	Method	Description
static CfnVolumeProps.Builder	builder()
default Object	getAutoEnableIo()	Indicates whether the volume is auto-enabled for I/O operations.
String	getAvailabilityZone()	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).
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.
default Number	getSize()	The size of the volume, in GiBs.
default String	getSnapshotId()	The snapshot from which to create the volume.
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 String	getVolumeType()	The volume type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAvailabilityZone

@Stability(Stable)
@NotNull
String getAvailabilityZone()

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

For example, us-east-1a .

See Also:

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

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.

See Also:

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

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 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 EBS User Guide .

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

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).

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 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.

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.

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.

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.

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.

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 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.

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

See Also:

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

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

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

For more information, see Amazon EBS volume types .

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 CfnVolumeProps.Builder builder()

Returns:

a CfnVolumeProps.Builder of CfnVolumeProps