Package software.amazon.awscdk.services.workspacesinstances

Class CfnVolumeAssociation

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.workspacesinstances.CfnVolumeAssociation

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IVolumeAssociationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-12T17:54:24.695Z")
@Stability(Stable)
public class CfnVolumeAssociation
extends CfnResource
implements IInspectable, IVolumeAssociationRef

Resource Type definition for AWS::WorkspacesInstances::VolumeAssociation.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.workspacesinstances.*;
 CfnVolumeAssociation cfnVolumeAssociation = CfnVolumeAssociation.Builder.create(this, "MyCfnVolumeAssociation")
         .device("device")
         .volumeId("volumeId")
         .workspaceInstanceId("workspaceInstanceId")
         // the properties below are optional
         .disassociateMode("disassociateMode")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnVolumeAssociation.Builder	A fluent builder for CfnVolumeAssociation.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.workspacesinstances.IVolumeAssociationRef

IVolumeAssociationRef.Jsii$Default, IVolumeAssociationRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnVolumeAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVolumeAssociation(software.amazon.jsii.JsiiObjectRef objRef)
	CfnVolumeAssociation(software.constructs.Construct scope, String id, CfnVolumeAssociationProps props)	Create a new AWS::WorkspacesInstances::VolumeAssociation.

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
String	getDevice()	The device name for the volume attachment.
String	getDisassociateMode()	Mode to use when disassociating the volume.
VolumeAssociationReference	getVolumeAssociationRef()	A reference to a VolumeAssociation resource.
String	getVolumeId()	ID of the volume to attach to the workspace instance.
String	getWorkspaceInstanceId()	ID of the workspace instance to associate with the volume.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnVolumeAssociation(Object x)	Checks whether the given object is a CfnVolumeAssociation.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDevice(String value)	The device name for the volume attachment.
void	setDisassociateMode(String value)	Mode to use when disassociating the volume.
void	setVolumeId(String value)	ID of the volume to attach to the workspace instance.
void	setWorkspaceInstanceId(String value)	ID of the workspace instance to associate with the volume.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnVolumeAssociation

protected CfnVolumeAssociation(software.amazon.jsii.JsiiObjectRef objRef)

CfnVolumeAssociation

protected CfnVolumeAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnVolumeAssociation

@Stability(Stable)
public CfnVolumeAssociation(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnVolumeAssociationProps props)

Create a new AWS::WorkspacesInstances::VolumeAssociation.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

isCfnVolumeAssociation

@Stability(Stable)
@NotNull
public static Boolean isCfnVolumeAssociation(@NotNull
 Object x)

Checks whether the given object is a CfnVolumeAssociation.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getVolumeAssociationRef

@Stability(Stable)
@NotNull
public VolumeAssociationReference getVolumeAssociationRef()

A reference to a VolumeAssociation resource.

Specified by:

getVolumeAssociationRef in interface IVolumeAssociationRef

getDevice

@Stability(Stable)
@NotNull
public String getDevice()

The device name for the volume attachment.

setDevice

@Stability(Stable)
public void setDevice(@NotNull
 String value)

The device name for the volume attachment.

getVolumeId

@Stability(Stable)
@NotNull
public String getVolumeId()

ID of the volume to attach to the workspace instance.

setVolumeId

@Stability(Stable)
public void setVolumeId(@NotNull
 String value)

ID of the volume to attach to the workspace instance.

getWorkspaceInstanceId

@Stability(Stable)
@NotNull
public String getWorkspaceInstanceId()

ID of the workspace instance to associate with the volume.

setWorkspaceInstanceId

@Stability(Stable)
public void setWorkspaceInstanceId(@NotNull
 String value)

ID of the workspace instance to associate with the volume.

getDisassociateMode

@Stability(Stable)
@Nullable
public String getDisassociateMode()

Mode to use when disassociating the volume.

setDisassociateMode

@Stability(Stable)
public void setDisassociateMode(@Nullable
 String value)

Mode to use when disassociating the volume.