Class EbsDeviceOptionsBase

Base block device options for an EBS volume.

Inheritance
System.Object
EbsDeviceOptionsBase
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EbsDeviceOptionsBase : Object, IEbsDeviceOptionsBase
Syntax (vb)
Public Class EbsDeviceOptionsBase
    Inherits Object
    Implements IEbsDeviceOptionsBase
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;

var ebsDeviceOptionsBase = new EbsDeviceOptionsBase {
    DeleteOnTermination = false,
    Iops = 123,
    Throughput = 123,
    VolumeType = EbsDeviceVolumeType.STANDARD
};

Synopsis

Constructors

EbsDeviceOptionsBase()

Properties

DeleteOnTermination

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

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

The throughput to provision for a gp3 volume.
VolumeType

The EBS volume type.

Constructors

EbsDeviceOptionsBase()

public EbsDeviceOptionsBase()

Properties

DeleteOnTermination

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

public Nullable<bool> DeleteOnTermination { get; set; }
Property Value

System.Nullable<System.Boolean>

Remarks

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.

public Nullable<double> Iops { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

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.

public Nullable<double> Throughput { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

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

VolumeType

The EBS volume type.

public Nullable<EbsDeviceVolumeType> VolumeType { get; set; }
Property Value

System.Nullable<EbsDeviceVolumeType>

Remarks

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

Implements