Class EbsDeviceProps
Properties of an EBS block device.
Inheritance
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EbsDeviceProps : Object, IEbsDeviceProps, IEbsDeviceSnapshotOptions, IEbsDeviceOptionsBase
Syntax (vb)
Public Class EbsDeviceProps
Inherits Object
Implements IEbsDeviceProps, 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.AutoScaling;
var ebsDeviceProps = new EbsDeviceProps {
DeleteOnTermination = false,
Iops = 123,
SnapshotId = "snapshotId",
Throughput = 123,
VolumeSize = 123,
VolumeType = EbsDeviceVolumeType.STANDARD
};
Synopsis
Constructors
EbsDeviceProps() |
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. |
SnapshotId | The snapshot ID of the volume to use. |
Throughput | The throughput that the volume supports, in MiB/s Takes a minimum of 125 and maximum of 1000. |
VolumeSize | The volume size, in Gibibytes (GiB). |
VolumeType | The EBS volume type. |
Constructors
EbsDeviceProps()
public EbsDeviceProps()
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
SnapshotId
The snapshot ID of the volume to use.
public string SnapshotId { get; set; }
Property Value
System.String
Remarks
Default: - No snapshot will be used
Throughput
The throughput that the volume supports, in MiB/s Takes a minimum of 125 and maximum of 1000.
public Nullable<double> Throughput { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - 125 MiB/s. Only valid on gp3 volumes.
See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
VolumeSize
The volume size, in Gibibytes (GiB).
public Nullable<double> VolumeSize { get; set; }
Property Value
System.Nullable<System.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 Nullable<EbsDeviceVolumeType> VolumeType { get; set; }
Property Value
System.Nullable<EbsDeviceVolumeType>
Remarks
Default: EbsDeviceVolumeType.GP2
See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html