Class CfnInstance.EbsProperty

Specifies a block device for an EBS volume.

Inheritance

object

CfnInstance.EbsProperty

Implements

CfnInstance.IEbsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnInstance.EbsProperty : CfnInstance.IEbsProperty

Syntax (vb)

Public Class CfnInstance.EbsProperty Implements CfnInstance.IEbsProperty

Remarks

Ebs is a property of the BlockDeviceMapping property type.

After the instance is running, you can modify only the <code>DeleteOnTermination</code> parameters for the attached volumes without interrupting the instance. Modifying any other parameter results in instance <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">replacement</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-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",
                 VolumeSize = 123,
                 VolumeType = "volumeType"
             };

Synopsis

Constructors

EbsProperty()

Specifies a block device for an EBS volume.

Properties

DeleteOnTermination	Indicates whether the EBS volume is deleted on instance termination.
Encrypted	Indicates whether the volume should be encrypted.
Iops	The number of I/O operations per second (IOPS).
KmsKeyId	The identifier of the AWS KMS key to use for Amazon EBS encryption.
SnapshotId	The ID of the snapshot.
VolumeSize	The size of the volume, in GiBs.
VolumeType	The volume type.

Constructors

EbsProperty()

Specifies a block device for an EBS volume.

public EbsProperty()

Remarks

Ebs is a property of the BlockDeviceMapping property type.

After the instance is running, you can modify only the <code>DeleteOnTermination</code> parameters for the attached volumes without interrupting the instance. Modifying any other parameter results in instance <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">replacement</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-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",
                 VolumeSize = 123,
                 VolumeType = "volumeType"
             };

Properties

DeleteOnTermination

Indicates whether the EBS volume is deleted on instance termination.

public object? DeleteOnTermination { get; set; }

Property Value

object

Remarks

For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .

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

Type union: either bool or IResolvable

Encrypted

Indicates whether the volume should be encrypted.

public object? Encrypted { get; set; }

Property Value

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 Encryption by default in the Amazon Elastic Compute Cloud User Guide .

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .

After the instance is running, modifying this parameter results in instance <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">replacement</a> .

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

Type union: either bool or IResolvable

Iops

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

public double? Iops { get; set; }

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

After the instance is running, modifying this parameter results in instance <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">replacement</a> .

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

KmsKeyId

The identifier of the AWS KMS key to use for Amazon EBS encryption.

public string? KmsKeyId { get; set; }

Property Value

string

Remarks

If KmsKeyId is specified, the encrypted state must be true . If the encrypted state is true but you do not specify KmsKeyId , your KMS key for EBS is used.

You can specify the KMS key using any of the following:

After the instance is running, modifying this parameter results in instance <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">replacement</a> .

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

SnapshotId

The ID of the snapshot.

public string? SnapshotId { get; set; }

Property Value

string

Remarks

If you specify both SnapshotId and VolumeSize , VolumeSize must be equal or greater than the size of the snapshot.

After the instance is running, modifying this parameter results in instance <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">replacement</a> .

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

VolumeSize

The size of the volume, in GiBs.

public double? VolumeSize { get; set; }

Property Value

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:

After the instance is running, modifying this parameter results in instance <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">replacement</a> .

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

VolumeType

The volume type.

public string? VolumeType { get; set; }

Property Value

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.

After the instance is running, modifying this parameter results in instance <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">replacement</a> .

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

Implements

CfnInstance.IEbsProperty