Show / Hide Table of Contents

Interface ICfnVolumeProps

Properties for defining a CfnVolume.

Namespace: Amazon.CDK.AWS.WorkspacesInstances

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnVolumeProps

Syntax (vb)

Public Interface ICfnVolumeProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.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.WorkspacesInstances;

             var cfnVolumeProps = new CfnVolumeProps {
                 AvailabilityZone = "availabilityZone",

                 // the properties below are optional
                 Encrypted = false,
                 Iops = 123,
                 KmsKeyId = "kmsKeyId",
                 SizeInGb = 123,
                 SnapshotId = "snapshotId",
                 TagSpecifications = new [] { new TagSpecificationProperty {
                     ResourceType = "resourceType",
                     Tags = new [] { new CfnTag {
                         Key = "key",
                         Value = "value"
                     } }
                 } },
                 Throughput = 123,
                 VolumeType = "volumeType"
             };

Synopsis

Properties

AvailabilityZone	The Availability Zone in which to create the volume.
Encrypted	Indicates whether the volume should be encrypted.
Iops	The number of I/O operations per second (IOPS).
KmsKeyId	The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.
SizeInGb	The size of the volume, in GiBs.
SnapshotId	The snapshot from which to create the volume.
TagSpecifications	The tags passed to EBS volume.
Throughput	The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
VolumeType	The volume type.

Properties

AvailabilityZone

The Availability Zone in which to create the volume.

string AvailabilityZone { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-availabilityzone

Encrypted

Indicates whether the volume should be encrypted.

object? Encrypted { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-encrypted

Type union: either bool or IResolvable

Iops

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

double? Iops { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-iops

KmsKeyId

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.

string? KmsKeyId { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-kmskeyid

SizeInGb

The size of the volume, in GiBs.

double? SizeInGb { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-sizeingb

SnapshotId

The snapshot from which to create the volume.

string? SnapshotId { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-snapshotid

TagSpecifications

The tags passed to EBS volume.

object? TagSpecifications { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-tagspecifications

Type union: either IResolvable or (either IResolvable or CfnVolume.ITagSpecificationProperty)[]

Throughput

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

double? Throughput { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-throughput

VolumeType

The volume type.

string? VolumeType { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-volumetype