Package software.amazon.awscdk.cfnpropertymixins.services.workspacesinstances

Interface CfnVolumeMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVolumeMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:06.323Z")
@Stability(Stable)
public interface CfnVolumeMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnVolumePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.workspacesinstances.*;
 CfnVolumeMixinProps cfnVolumeMixinProps = CfnVolumeMixinProps.builder()
         .availabilityZone("availabilityZone")
         .encrypted(false)
         .iops(123)
         .kmsKeyId("kmsKeyId")
         .sizeInGb(123)
         .snapshotId("snapshotId")
         .tagSpecifications(List.of(TagSpecificationProperty.builder()
                 .resourceType("resourceType")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         .throughput(123)
         .volumeType("volumeType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVolumeMixinProps.Builder	A builder for CfnVolumeMixinProps
static final class	CfnVolumeMixinProps.Jsii$Proxy	An implementation for CfnVolumeMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnVolumeMixinProps.Builder	builder()
default String	getAvailabilityZone()	The Availability Zone in which to create the volume.
default Object	getEncrypted()	Indicates whether the volume should be encrypted.
default Number	getIops()	The number of I/O operations per second (IOPS).
default String	getKmsKeyId()	The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.
default Number	getSizeInGb()	The size of the volume, in GiBs.
default String	getSnapshotId()	The snapshot from which to create the volume.
default Object	getTagSpecifications()	The tags passed to EBS volume.
default Number	getThroughput()	The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
default String	getVolumeType()	The volume type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAvailabilityZone

@Stability(Stable)
@Nullable
default String getAvailabilityZone()

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

getEncrypted

@Stability(Stable)
@Nullable
default Object getEncrypted()

Indicates whether the volume should be encrypted.

Returns union: either Boolean or IResolvable

See Also:

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

getIops

@Stability(Stable)
@Nullable
default Number getIops()

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

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

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

getSizeInGb

@Stability(Stable)
@Nullable
default Number getSizeInGb()

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

getSnapshotId

@Stability(Stable)
@Nullable
default String getSnapshotId()

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

getTagSpecifications

@Stability(Stable)
@Nullable
default Object getTagSpecifications()

The tags passed to EBS volume.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnVolumePropsMixin.TagSpecificationProperty>

See Also:

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

getThroughput

@Stability(Stable)
@Nullable
default Number getThroughput()

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

getVolumeType

@Stability(Stable)
@Nullable
default String getVolumeType()

The volume type.

See Also:

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

builder

@Stability(Stable)
static CfnVolumeMixinProps.Builder builder()

Returns:

a CfnVolumeMixinProps.Builder of CfnVolumeMixinProps