software.amazon.awscdk.services.autoscaling

Interface EbsDeviceOptionsBase

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.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.988Z")
public interface EbsDeviceOptionsBase

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.autoscaling.*;
 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 java.lang.Boolean	getDeleteOnTermination() Indicates whether to delete the volume when the instance is terminated.
default java.lang.Number	getIops() The number of I/O operations per second (IOPS) to provision for the volume.
default EbsDeviceVolumeType	getVolumeType() The EBS volume type.

Method Detail

getDeleteOnTermination

default java.lang.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

default java.lang.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

default EbsDeviceVolumeType getVolumeType()

The EBS volume type.

Default: EbsDeviceVolumeType.GP2

See Also:

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

builder

static EbsDeviceOptionsBase.Builder builder()

Returns:

a EbsDeviceOptionsBase.Builder of EbsDeviceOptionsBase