Class CfnSpotFleet.EbsBlockDeviceProperty
Describes a block device for an EBS volume.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class EbsBlockDeviceProperty : Object, CfnSpotFleet.IEbsBlockDeviceProperty
Syntax (vb)
Public Class EbsBlockDeviceProperty
Inherits Object
Implements CfnSpotFleet.IEbsBlockDeviceProperty
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 ebsBlockDeviceProperty = new EbsBlockDeviceProperty {
DeleteOnTermination = false,
Encrypted = false,
Iops = 123,
SnapshotId = "snapshotId",
VolumeSize = 123,
VolumeType = "volumeType"
};
Synopsis
Constructors
EbsBlockDeviceProperty() |
Properties
DeleteOnTermination | Indicates whether the EBS volume is deleted on instance termination. |
Encrypted | Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. |
Iops | The number of I/O operations per second (IOPS). |
SnapshotId | The ID of the snapshot. |
VolumeSize | The size of the volume, in GiBs. |
VolumeType | The volume type. |
Constructors
EbsBlockDeviceProperty()
public EbsBlockDeviceProperty()
Properties
DeleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
public object DeleteOnTermination { get; set; }
Property Value
System.Object
Remarks
For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
Encrypted
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.
public object Encrypted { get; set; }
Property Value
System.Object
Remarks
The effect of setting the encryption state to true
depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS Encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types .
This parameter is not returned by DescribeImageAttribute .
Iops
The number of I/O operations per second (IOPS).
public Nullable<double> Iops { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1
and io2
volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1
and io2
volumes. The default for gp3
volumes is 3,000 IOPS. This parameter is not supported for gp2
, st1
, sc1
, or standard
volumes.
SnapshotId
The ID of the snapshot.
public string SnapshotId { get; set; }
Property Value
System.String
Remarks
VolumeSize
The size of the volume, in GiBs.
public Nullable<double> VolumeSize { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
VolumeType
The volume type.
public string VolumeType { get; set; }
Property Value
System.String
Remarks
For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1
or io2
, you must specify the IOPS that the volume supports.