Interface CfnLaunchConfiguration.IBlockDeviceProperty

BlockDevice is a property of the EBS property of the AWS::AutoScaling::LaunchConfiguration BlockDeviceMapping property type that describes an Amazon EBS volume.

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.AWS.AutoScaling.dll

Syntax (csharp)

public interface IBlockDeviceProperty

Syntax (vb)

Public Interface IBlockDeviceProperty

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html

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

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 gp3 volume.
VolumeSize	The volume size, in GiBs. The following are the supported volumes sizes for each volume type:.
VolumeType	The volume type.

Properties

DeleteOnTermination

Indicates whether the volume is deleted on instance termination.

virtual object DeleteOnTermination { get; }

Property Value

System.Object

Remarks

For Amazon EC2 Auto Scaling, the default value is true .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-deleteontermination

Encrypted

Specifies whether the volume should be encrypted.

virtual object Encrypted { get; }

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-encrypted

Iops

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

virtual Nullable<double> Iops { get; }

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.)

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-iops

SnapshotId

The snapshot ID of the volume to use.

virtual string SnapshotId { get; }

Property Value

System.String

Remarks

You must specify either a VolumeSize or a SnapshotId .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-snapshotid

Throughput

The throughput (MiBps) to provision for a gp3 volume.

virtual Nullable<double> Throughput { get; }

Property Value

System.Nullable<System.Double>

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-throughput

VolumeSize

The volume size, in GiBs. The following are the supported volumes sizes for each volume type:.

virtual Nullable<double> VolumeSize { get; }

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-volumesize

VolumeType

The volume type.

virtual string VolumeType { get; }

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-volumetype