Package software.amazon.awscdk.services.ec2

Interface EbsDeviceOptionsBase

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

EbsDeviceOptions, EbsDeviceProps, EbsDeviceSnapshotOptions

All Known Implementing Classes:

EbsDeviceOptions.Jsii$Proxy, EbsDeviceOptionsBase.Jsii$Proxy, EbsDeviceProps.Jsii$Proxy, EbsDeviceSnapshotOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:08.715Z")
@Stability(Stable)
public interface EbsDeviceOptionsBase
extends software.amazon.jsii.JsiiSerializable

Base block device options for an EBS volume.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.ec2.*;
 Size size;
 EbsDeviceOptionsBase ebsDeviceOptionsBase = EbsDeviceOptionsBase.builder()
         .deleteOnTermination(false)
         .iops(123)
         .throughput(123)
         .volumeInitializationRate(size)
         .volumeType(EbsDeviceVolumeType.STANDARD)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EbsDeviceOptionsBase.Builder	builder()
default Boolean	getDeleteOnTermination()	Indicates whether to delete the volume when the instance is terminated.
default Number	getIops()	The number of I/O operations per second (IOPS) to provision for the volume.
default Number	getThroughput()	The throughput to provision for a gp3 volume.
default Size	getVolumeInitializationRate()	The Amazon EBS Provisioned Rate for Volume Initialization, at which to download the snapshot blocks from Amazon S3 to the volume.
default EbsDeviceVolumeType	getVolumeType()	The EBS volume type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeleteOnTermination

@Stability(Stable)
@Nullable
default Boolean getDeleteOnTermination()

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

Default: - true for Amazon EC2 Auto Scaling, false otherwise (e.g. EBS)

getIops

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

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 Also:

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

getThroughput

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

The throughput to provision for a gp3 volume.

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

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 Also:

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

getVolumeInitializationRate

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

The Amazon EBS Provisioned Rate for Volume Initialization, at which to download the snapshot blocks from Amazon S3 to the volume.

Valid range is between 100 and 300 MiB/s. This parameter is supported only for volumes created from snapshots.

Default: undefined - The volume initialization rate is not set.

See Also:

• https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html#volume-initialization-rate

getVolumeType

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

The EBS volume type.

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

See Also:

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

builder

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

Returns:

a EbsDeviceOptionsBase.Builder of EbsDeviceOptionsBase