Class EbsDeviceSnapshotOptions

Block device options for an EBS volume created from a snapshot.

Inheritance

object

EbsDeviceSnapshotOptions

Implements

IEbsDeviceSnapshotOptions

IEbsDeviceOptionsBase

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class EbsDeviceSnapshotOptions : IEbsDeviceSnapshotOptions, IEbsDeviceOptionsBase

Syntax (vb)

Public Class EbsDeviceSnapshotOptions Implements IEbsDeviceSnapshotOptions, 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 ebsDeviceSnapshotOptions = new EbsDeviceSnapshotOptions {
                DeleteOnTermination = false,
                Iops = 123,
                Throughput = 123,
                VolumeSize = 123,
                VolumeType = EbsDeviceVolumeType.STANDARD
            };

Synopsis

Constructors

EbsDeviceSnapshotOptions()

Block device options for an EBS volume created from a snapshot.

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.
VolumeSize	The volume size, in Gibibytes (GiB).
VolumeType	The EBS volume type.

Constructors

EbsDeviceSnapshotOptions()

Block device options for an EBS volume created from a snapshot.

public EbsDeviceSnapshotOptions()

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 ebsDeviceSnapshotOptions = new EbsDeviceSnapshotOptions {
                DeleteOnTermination = false,
                Iops = 123,
                Throughput = 123,
                VolumeSize = 123,
                VolumeType = EbsDeviceVolumeType.STANDARD
            };

Properties

DeleteOnTermination

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

public bool? DeleteOnTermination { get; set; }

Property Value

bool?

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 double? Iops { get; set; }

Property Value

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 double? Throughput { get; set; }

Property Value

double?

Remarks

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: https://docs.aws.amazon.com/ebs/latest/userguide/general-purpose.html#gp3-performance

VolumeSize

The volume size, in Gibibytes (GiB).

public double? VolumeSize { get; set; }

Property Value

double?

Remarks

If you specify volumeSize, it must be equal or greater than the size of the snapshot.

Default: - The snapshot size

VolumeType

The EBS volume type.

public EbsDeviceVolumeType? VolumeType { get; set; }

Property Value

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

IEbsDeviceSnapshotOptions

IEbsDeviceOptionsBase