EbsDeviceOptions

class aws_cdk.aws_autoscaling.EbsDeviceOptions(*, delete_on_termination=None, iops=None, volume_type=None, encrypted=None)

Bases: EbsDeviceOptionsBase

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 {@link volumeType}: {@link 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 {@link EbsDeviceVolumeType.IO1}

  • volume_type (Optional[EbsDeviceVolumeType]) – The EBS volume type. Default: {@link EbsDeviceVolumeType.GP2}

  • encrypted (Optional[bool]) – Specifies whether the EBS volume is encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption Default: false

ExampleMetadata

fixture=_generated

Example:

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

ebs_device_options = autoscaling.EbsDeviceOptions(
    delete_on_termination=False,
    encrypted=False,
    iops=123,
    volume_type=autoscaling.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)

encrypted

Specifies whether the EBS volume is encrypted.

Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption

Default

false

See

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances

iops

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

Must only be set for {@link volumeType}: {@link 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 {@link EbsDeviceVolumeType.IO1}

See

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

volume_type

The EBS volume type.

Default

{@link EbsDeviceVolumeType.GP2}

See

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