Package software.amazon.awscdk.services.workspaces

Interface CfnWorkspace.WorkspacePropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkspace.WorkspacePropertiesProperty.Jsii$Proxy

Enclosing class:

CfnWorkspace

@Stability(Stable)
public static interface CfnWorkspace.WorkspacePropertiesProperty
extends software.amazon.jsii.JsiiSerializable

Information about a WorkSpace.

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.workspaces.*;
 WorkspacePropertiesProperty workspacePropertiesProperty = WorkspacePropertiesProperty.builder()
         .computeTypeName("computeTypeName")
         .rootVolumeSizeGib(123)
         .runningMode("runningMode")
         .runningModeAutoStopTimeoutInMinutes(123)
         .userVolumeSizeGib(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWorkspace.WorkspacePropertiesProperty.Builder	builder()
default String	getComputeTypeName()	The compute type.
default Number	getRootVolumeSizeGib()	The size of the root volume.
default String	getRunningMode()	The running mode.
default Number	getRunningModeAutoStopTimeoutInMinutes()	The time after a user logs off when WorkSpaces are automatically stopped.
default Number	getUserVolumeSizeGib()	The size of the user storage.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComputeTypeName

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

The compute type.

For more information, see Amazon WorkSpaces Bundles .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-computetypename

getRootVolumeSizeGib

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

The size of the root volume.

For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-rootvolumesizegib

getRunningMode

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

The running mode. For more information, see Manage the WorkSpace Running Mode .

The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-runningmode

getRunningModeAutoStopTimeoutInMinutes

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

The time after a user logs off when WorkSpaces are automatically stopped.

Configured in 60-minute intervals.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-runningmodeautostoptimeoutinminutes

getUserVolumeSizeGib

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

The size of the user storage.

For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-uservolumesizegib

builder

@Stability(Stable)
static CfnWorkspace.WorkspacePropertiesProperty.Builder builder()

Returns:

a CfnWorkspace.WorkspacePropertiesProperty.Builder of CfnWorkspace.WorkspacePropertiesProperty