Class CfnLaunchConfiguration.BlockDeviceProperty
BlockDevice
is a property of the EBS
property of the AWS::AutoScaling::LaunchConfiguration BlockDeviceMapping property type that describes an Amazon EBS volume.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.AWS.AutoScaling.dll
Syntax (csharp)
public class BlockDeviceProperty : Object, CfnLaunchConfiguration.IBlockDeviceProperty
Syntax (vb)
Public Class BlockDeviceProperty
Inherits Object
Implements CfnLaunchConfiguration.IBlockDeviceProperty
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 blockDeviceProperty = new BlockDeviceProperty {
DeleteOnTermination = false,
Encrypted = false,
Iops = 123,
SnapshotId = "snapshotId",
Throughput = 123,
VolumeSize = 123,
VolumeType = "volumeType"
};
Synopsis
Constructors
BlockDeviceProperty() |
Properties
DeleteOnTermination | Indicates whether the volume is deleted on instance termination. |
Encrypted | Specifies whether the volume should be encrypted. |
Iops | The number of input/output (I/O) operations per second (IOPS) to provision for the volume. |
SnapshotId | The snapshot ID of the volume to use. |
Throughput | The throughput (MiBps) to provision for a |
VolumeSize | The volume size, in GiBs. The following are the supported volumes sizes for each volume type:. |
VolumeType | The volume type. |
Constructors
BlockDeviceProperty()
public BlockDeviceProperty()
Properties
DeleteOnTermination
Indicates whether the volume is deleted on instance termination.
public object DeleteOnTermination { get; set; }
Property Value
System.Object
Remarks
For Amazon EC2 Auto Scaling, the default value is true
.
Encrypted
Specifies whether the volume should be encrypted.
public object Encrypted { get; set; }
Property Value
System.Object
Remarks
Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types . If your AMI uses encrypted volumes, you can also only launch it on supported instance types.
If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.
If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the AWS managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.
For more information, see Use AWS KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide .
Iops
The number of input/output (I/O) operations per second (IOPS) to provision for the volume.
public Nullable<double> Iops { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
For gp3
and io1
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
volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
Iops
is supported when the volume type is gp3
or io1
and required only when the volume type is io1
. (Not used with standard
, gp2
, st1
, or sc1
volumes.)
SnapshotId
The snapshot ID of the volume to use.
public string SnapshotId { get; set; }
Property Value
System.String
Remarks
You must specify either a VolumeSize
or a SnapshotId
.
Throughput
The throughput (MiBps) to provision for a gp3
volume.
public Nullable<double> Throughput { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
VolumeSize
The volume size, in GiBs. The following are the supported volumes sizes for each volume type:.
public Nullable<double> VolumeSize { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
You must specify either a SnapshotId
or a VolumeSize
. If you specify both SnapshotId
and VolumeSize
, the volume size must be equal or greater than the size of the snapshot.
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 for Linux Instances .
Valid values: standard
| io1
| gp2
| st1
| sc1
| gp3