Interface CfnLaunchTemplate.IEbsProperty

Parameters for a block device for an EBS volume in an Amazon EC2 launch template.

Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnLaunchTemplate.IEbsProperty
Syntax (vb)
Public Interface CfnLaunchTemplate.IEbsProperty
Remarks

Ebs is a property of AWS::EC2::LaunchTemplate BlockDeviceMapping .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.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.EC2;

             var ebsProperty = new EbsProperty {
                 DeleteOnTermination = false,
                 Encrypted = false,
                 Iops = 123,
                 KmsKeyId = "kmsKeyId",
                 SnapshotId = "snapshotId",
                 Throughput = 123,
                 VolumeInitializationRate = 123,
                 VolumeSize = 123,
                 VolumeType = "volumeType"
             };

Synopsis

Properties

DeleteOnTermination

Indicates whether the EBS volume is deleted on instance termination.
Encrypted

Indicates whether the EBS volume is encrypted.
Iops

The number of I/O operations per second (IOPS).
KmsKeyId

Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.
SnapshotId

The ID of the snapshot.
Throughput

The throughput to provision for a gp3 volume, with a maximum of 2,000 MiB/s.
VolumeInitializationRate

Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume.
VolumeSize

The size of the volume, in GiBs.
VolumeType

The volume type.

Properties

DeleteOnTermination

Indicates whether the EBS volume is deleted on instance termination.

object? DeleteOnTermination { get; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-deleteontermination

Type union: either bool or IResolvable

Encrypted

Indicates whether the EBS volume is encrypted.

object? Encrypted { get; }
Property Value

object

Remarks

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-encrypted

Type union: either bool or IResolvable

Iops

The number of I/O operations per second (IOPS).

double? Iops { get; }
Property Value

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 io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System . On other instances, you can achieve performance up to 32,000 IOPS.

    This parameter is supported for io1 , io2 , and gp3 volumes only.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-iops

    KmsKeyId

    Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.

    string? KmsKeyId { get; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-kmskeyid

    SnapshotId

    The ID of the snapshot.

    string? SnapshotId { get; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-snapshotid

    Throughput

    The throughput to provision for a gp3 volume, with a maximum of 2,000 MiB/s.

    double? Throughput { get; }
    Property Value

    double?

    Remarks

    Valid Range: Minimum value of 125. Maximum value of 2,000.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-throughput

    VolumeInitializationRate

    Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume.

    double? VolumeInitializationRate { get; }
    Property Value

    double?

    Remarks

    This is also known as volume initialization . Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.

    This parameter is supported only for volumes created from snapshots. Omit this parameter if:

      If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.

        For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide .

        Valid range: 100 - 300 MiB/s

        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-volumeinitializationrate

        VolumeSize

        The size of the volume, in GiBs.

        double? VolumeSize { get; }
        Property Value

        double?

        Remarks

        You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-volumesize

          VolumeType

          The volume type.

          string? VolumeType { get; }
          Property Value

          string

          Remarks

          For more information, see Amazon EBS volume types in the Amazon EBS User Guide .

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-volumetype