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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.411Z")
 @Stability(value=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.services.ec2.*;
 EbsDeviceOptionsBase ebsDeviceOptionsBase = EbsDeviceOptionsBase.builder()
         .deleteOnTermination(false)
         .iops(123)
         .volumeType(EbsDeviceVolumeType.STANDARD)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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 EbsDeviceVolumeType	getVolumeType() The EBS volume type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDeleteOnTermination

@Stability(value=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(value=Stable)
 @Nullable
default Number getIops()

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

See Also:

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

getVolumeType

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

The EBS volume type.

Default: EbsDeviceVolumeType.GP2

See Also:

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

builder

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

Returns:

a EbsDeviceOptionsBase.Builder of EbsDeviceOptionsBase