Interface CfnEC2Fleet.IEbsBlockDeviceProperty

Describes a block device for an EBS volume.

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnEC2Fleet.IEbsBlockDeviceProperty

Syntax (vb)

Public Interface CfnEC2Fleet.IEbsBlockDeviceProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ebsblockdevice.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 ebsBlockDeviceProperty = new EbsBlockDeviceProperty {
                 DeleteOnTermination = false,
                 Encrypted = false,
                 Iops = 123,
                 KmsKeyId = "kmsKeyId",
                 SnapshotId = "snapshotId",
                 VolumeSize = 123,
                 VolumeType = "volumeType"
             };

Synopsis

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

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-ec2fleet-ebsblockdevice.html#cfn-ec2-ec2fleet-ebsblockdevice-deleteontermination

Type union: either bool or IResolvable

Encrypted

Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.

object? Encrypted { get; }

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 Amazon EBS encryption in the Amazon EBS 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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ebsblockdevice.html#cfn-ec2-ec2fleet-ebsblockdevice-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 required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ebsblockdevice.html#cfn-ec2-ec2fleet-ebsblockdevice-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

This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ebsblockdevice.html#cfn-ec2-ec2fleet-ebsblockdevice-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-ec2fleet-ebsblockdevice.html#cfn-ec2-ec2fleet-ebsblockdevice-snapshotid

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. 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 sizes for each volume type:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ebsblockdevice.html#cfn-ec2-ec2fleet-ebsblockdevice-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-ec2fleet-ebsblockdevice.html#cfn-ec2-ec2fleet-ebsblockdevice-volumetype