Skip to content
v2.274.0

CfnVolumeProps Struct ​

Properties for defining a CfnVolume.

Example ​

ts
// 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 ​

availabilityZonestringavailability_zonestravailabilityZoneStringAvailabilityZonestringAvailabilityZone*stringrequired#
The Availability Zone in which to create the volume.
encryptedboolean | IResolvableencryptedtyping.Union[bool, IResolvable]encryptedBooleanEncryptedboolEncryptedinterface{}#
Indicates whether the volume should be encrypted.
iopsnumberiopsint | floatiopsNumberIopsdoubleIops*float64#
The number of I/O operations per second (IOPS).
kmsKeyIdstringkms_key_idstrkmsKeyIdStringKmsKeyIdstringKmsKeyId*string#
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.
sizeInGbnumbersize_in_gbint | floatsizeInGbNumberSizeInGbdoubleSizeInGb*float64#
The size of the volume, in GiBs.
snapshotIdstringsnapshot_idstrsnapshotIdStringSnapshotIdstringSnapshotId*string#
The snapshot from which to create the volume.
tagSpecificationsIResolvable | IResolvable | CfnVolume.TagSpecificationProperty[]tag_specificationstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TagSpecificationProperty]]]tagSpecificationsIResolvableTagSpecificationsIResolvableTagSpecificationsinterface{}#
The tags passed to EBS volume.
throughputnumberthroughputint | floatthroughputNumberThroughputdoubleThroughput*float64#
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
volumeTypestringvolume_typestrvolumeTypeStringVolumeTypestringVolumeType*string#
The volume type.

Used as props by ​