interface CfnVolumeProps

Language	Type name
.NET	Amazon.CDK.aws_workspacesinstances.CfnVolumeProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsworkspacesinstances#CfnVolumeProps
Java	software.amazon.awscdk.services.workspacesinstances.CfnVolumeProps
Python	aws_cdk.aws_workspacesinstances.CfnVolumeProps
TypeScript	aws-cdk-lib » aws_workspacesinstances » CfnVolumeProps

Properties for defining a CfnVolume.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspacesinstances as workspacesinstances } from 'aws-cdk-lib';
const cfnVolumeProps: workspacesinstances.CfnVolumeProps = {
  availabilityZone: 'availabilityZone',

  // the properties below are optional
  encrypted: false,
  iops: 123,
  kmsKeyId: 'kmsKeyId',
  sizeInGb: 123,
  snapshotId: 'snapshotId',
  tagSpecifications: [{
    resourceType: 'resourceType',
    tags: [{
      key: 'key',
      value: 'value',
    }],
  }],
  throughput: 123,
  volumeType: 'volumeType',
};

Properties

Name	Type	Description
availabilityZone	string	The Availability Zone in which to create the volume.
encrypted?	boolean | IResolvable	Indicates whether the volume should be encrypted.
iops?	number	The number of I/O operations per second (IOPS).
kmsKeyId?	string	The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.
sizeInGb?	number	The size of the volume, in GiBs.
snapshotId?	string	The snapshot from which to create the volume.
tagSpecifications?	IResolvable | IResolvable | TagSpecificationProperty[]	The tags passed to EBS volume.
throughput?	number	The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
volumeType?	string	The volume type.

---

availabilityZone

Type: string

The Availability Zone in which to create the volume.

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

---

encrypted?

Type: boolean | IResolvable (optional)

Indicates whether the volume should be encrypted.

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

---

iops?

Type: number (optional)

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

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

---

kmsKeyId?

Type: string (optional)

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

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

---

sizeInGb?

Type: number (optional)

The size of the volume, in GiBs.

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

---

snapshotId?

Type: string (optional)

The snapshot from which to create the volume.

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

---

tagSpecifications?

Type: IResolvable | IResolvable | TagSpecificationProperty[] (optional)

The tags passed to EBS volume.

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

---

throughput?

Type: number (optional)

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

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

---

volumeType?

Type: string (optional)

The volume type.

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