EbsDeviceOptionsBase

class aws_cdk.aws_ec2.EbsDeviceOptionsBase(*, delete_on_termination=None, iops=None, throughput=None, volume_type=None)

Bases: object

Base block device options for an EBS volume.

Parameters:

  • delete_on_termination (Optional[bool]) – Indicates whether to delete the volume when the instance is terminated. Default: - true for Amazon EC2 Auto Scaling, false otherwise (e.g. EBS)

  • iops (Union[int, float, None]) – The number of I/O operations per second (IOPS) to provision for the volume. Must only be set for volumeType: EbsDeviceVolumeType.IO1 The maximum ratio of IOPS to volume size (in GiB) is 50:1, so for 5,000 provisioned IOPS, you need at least 100 GiB storage on the volume. Default: - none, required for EbsDeviceVolumeType.IO1

  • throughput (Union[int, float, None]) – The throughput to provision for a gp3 volume. Valid Range: Minimum value of 125. Maximum value of 1000. gp3 volumes deliver a consistent baseline throughput performance of 125 MiB/s. You can provision additional throughput for an additional cost at a ratio of 0.25 MiB/s per provisioned IOPS. Default: - 125 MiB/s.

  • volume_type (Optional[EbsDeviceVolumeType]) – The EBS volume type. Default: EbsDeviceVolumeType.GENERAL_PURPOSE_SSD or EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3 if @aws-cdk/aws-ec2:ebsDefaultGp3Volume is enabled.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

ebs_device_options_base = ec2.EbsDeviceOptionsBase(
    delete_on_termination=False,
    iops=123,
    throughput=123,
    volume_type=ec2.EbsDeviceVolumeType.STANDARD
)

Attributes

delete_on_termination

Indicates whether to delete the volume when the instance is terminated.

Default:

  • true for Amazon EC2 Auto Scaling, false otherwise (e.g. EBS)

iops

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

Must only be set for volumeType: EbsDeviceVolumeType.IO1

The maximum ratio of IOPS to volume size (in GiB) is 50:1, so for 5,000 provisioned IOPS, you need at least 100 GiB storage on the volume.

Default:

  • none, required for EbsDeviceVolumeType.IO1

See:

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html

throughput

The throughput to provision for a gp3 volume.

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

gp3 volumes deliver a consistent baseline throughput performance of 125 MiB/s. You can provision additional throughput for an additional cost at a ratio of 0.25 MiB/s per provisioned IOPS.

Default:

  • 125 MiB/s.

See:

https://docs.aws.amazon.com/ebs/latest/userguide/general-purpose.html#gp3-performance

volume_type

The EBS volume type.

Default:

EbsDeviceVolumeType.GENERAL_PURPOSE_SSD or EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3 if @aws-cdk/aws-ec2:ebsDefaultGp3Volume is enabled.

See:

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html