Skip to content

WorkspaceProperties

Source code in docs_src/capo_workspaces/types/workspace_properties.py
class WorkspaceProperties(TypedDict, closed=True):
    running_mode: NotRequired["capo_workspaces.types.running_mode.RunningMode"]
    """<p>The running mode. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html">Manage the WorkSpace Running Mode</a>.</p> <note> <p>The <code>MANUAL</code> value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p> </note> <p>Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see <a href="http://aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F"> Can I switch between hourly and monthly billing?</a> </p>"""
    running_mode_auto_stop_timeout_in_minutes: NotRequired[
        "capo_workspaces.types.running_mode_auto_stop_timeout_in_minutes.RunningModeAutoStopTimeoutInMinutes"
    ]
    """<p>The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.</p>"""
    root_volume_size_gib: NotRequired[
        "capo_workspaces.types.root_volume_size_gib.RootVolumeSizeGib"
    ]
    """<p>The size of the root volume. For important information about how to modify the size of the root and user volumes, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html">Modify a WorkSpace</a>.</p>"""
    user_volume_size_gib: NotRequired[
        "capo_workspaces.types.user_volume_size_gib.UserVolumeSizeGib"
    ]
    """<p>The size of the user storage. For important information about how to modify the size of the root and user volumes, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html">Modify a WorkSpace</a>.</p>"""
    compute_type_name: NotRequired["capo_workspaces.types.compute.Compute"]
    """<p>The compute type. For more information, see <a href="http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles">Amazon WorkSpaces Bundles</a>.</p>"""
    protocols: NotRequired["capo_workspaces.types.protocol_list.ProtocolList"]
    """<p>The protocol. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html"> Protocols for Amazon WorkSpaces</a>.</p> <note> <ul> <li> <p>Only available for WorkSpaces created with PCoIP bundles.</p> </li> <li> <p>The <code>Protocols</code> property is case sensitive. Ensure you use <code>PCOIP</code> or <code>DCV</code> (formerly WSP).</p> </li> <li> <p>Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, GraphicsPro.g4dn, Graphics.g6, and Graphics.g7).</p> </li> </ul> </note>"""
    operating_system_name: NotRequired[
        "capo_workspaces.types.operating_system_name.OperatingSystemName"
    ]
    """<p>The name of the operating system.</p>"""
    global_accelerator: NotRequired[
        "capo_workspaces.types.global_accelerator_for_work_space.GlobalAcceleratorForWorkSpace"
    ]
    """<p>Indicates the Global Accelerator properties.</p>"""
    nested_virtualization_enabled: NotRequired[
        "capo_workspaces.types.boolean_object.BooleanObject"
    ]
    """<p>Specifies whether nested virtualization is enabled for the WorkSpace.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/nested-virtualization.html">Nested virtualization for Amazon WorkSpaces</a>.</p>"""

compute_type_name instance-attribute

compute_type_name: NotRequired[Compute]

The compute type. For more information, see Amazon WorkSpaces Bundles.

global_accelerator instance-attribute

global_accelerator: NotRequired[GlobalAcceleratorForWorkSpace]

Indicates the Global Accelerator properties.

nested_virtualization_enabled instance-attribute

nested_virtualization_enabled: NotRequired[BooleanObject]

Specifies whether nested virtualization is enabled for the WorkSpace.

For more information, see Nested virtualization for Amazon WorkSpaces.

operating_system_name instance-attribute

operating_system_name: NotRequired[OperatingSystemName]

The name of the operating system.

protocols instance-attribute

protocols: NotRequired[ProtocolList]

The protocol. For more information, see Protocols for Amazon WorkSpaces.

  • Only available for WorkSpaces created with PCoIP bundles.

  • The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP).

  • Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, GraphicsPro.g4dn, Graphics.g6, and Graphics.g7).

root_volume_size_gib instance-attribute

root_volume_size_gib: NotRequired[RootVolumeSizeGib]

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.

running_mode instance-attribute

running_mode: NotRequired[RunningMode]

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.

Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

running_mode_auto_stop_timeout_in_minutes instance-attribute

running_mode_auto_stop_timeout_in_minutes: NotRequired[
    RunningModeAutoStopTimeoutInMinutes
]

The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

user_volume_size_gib instance-attribute

user_volume_size_gib: NotRequired[UserVolumeSizeGib]

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.