CfnVolumeProps

class aws_cdk.aws_workspacesinstances.CfnVolumeProps(*, availability_zone, encrypted=None, iops=None, kms_key_id=None, size_in_gb=None, snapshot_id=None, tag_specifications=None, throughput=None, volume_type=None)

Bases: object

Properties for defining a CfnVolume.

Parameters:
  • availability_zone (str) – The Availability Zone in which to create the volume.

  • encrypted (Union[bool, IResolvable, None]) – Indicates whether the volume should be encrypted.

  • iops (Union[int, float, None]) – The number of I/O operations per second (IOPS).

  • kms_key_id (Optional[str]) – The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.

  • size_in_gb (Union[int, float, None]) – The size of the volume, in GiBs.

  • snapshot_id (Optional[str]) – The snapshot from which to create the volume.

  • tag_specifications (Union[IResolvable, Sequence[Union[IResolvable, TagSpecificationProperty, Dict[str, Any]]], None]) – The tags passed to EBS volume.

  • throughput (Union[int, float, None]) – The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

  • volume_type (Optional[str]) – The volume type.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_workspacesinstances as workspacesinstances

cfn_volume_props = workspacesinstances.CfnVolumeProps(
    availability_zone="availabilityZone",

    # the properties below are optional
    encrypted=False,
    iops=123,
    kms_key_id="kmsKeyId",
    size_in_gb=123,
    snapshot_id="snapshotId",
    tag_specifications=[workspacesinstances.CfnVolume.TagSpecificationProperty(
        resource_type="resourceType",
        tags=[CfnTag(
            key="key",
            value="value"
        )]
    )],
    throughput=123,
    volume_type="volumeType"
)

Attributes

availability_zone

The Availability Zone in which to create the volume.

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.

See:

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

iops

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

See:

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

kms_key_id

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

See:

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

size_in_gb

The size of the volume, in GiBs.

See:

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

snapshot_id

The snapshot from which to create the volume.

See:

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

tag_specifications

The tags passed to EBS volume.

See:

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

throughput

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

See:

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

volume_type

The volume type.

See:

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