aws-native.workspaces.Workspace

AWS Cloud Control v1.54.0, Feb 16 26

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.54.0 published on Monday, Feb 16, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.54.0 published on Monday, Feb 16, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

Create Workspace Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Workspace(name: string, args: WorkspaceArgs, opts?: CustomResourceOptions);

@overload
def Workspace(resource_name: str,
              args: WorkspaceArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Workspace(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              bundle_id: Optional[str] = None,
              directory_id: Optional[str] = None,
              user_name: Optional[str] = None,
              root_volume_encryption_enabled: Optional[bool] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
              user_volume_encryption_enabled: Optional[bool] = None,
              volume_encryption_key: Optional[str] = None,
              workspace_properties: Optional[WorkspacePropertiesArgs] = None)

func NewWorkspace(ctx *Context, name string, args WorkspaceArgs, opts ...ResourceOption) (*Workspace, error)

public Workspace(string name, WorkspaceArgs args, CustomResourceOptions? opts = null)

public Workspace(String name, WorkspaceArgs args)
public Workspace(String name, WorkspaceArgs args, CustomResourceOptions options)

type: aws-native:workspaces:Workspace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args WorkspaceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args WorkspaceArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args WorkspaceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args WorkspaceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args WorkspaceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Workspace Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Workspace resource accepts the following input properties:

BundleId string: The identifier of the bundle for the WorkSpace.
DirectoryId string: The identifier of the Directory Service directory for the WorkSpace.
UserName string: The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
RootVolumeEncryptionEnabled bool: Indicates whether the data stored on the root volume is encrypted.
Tags List<Pulumi.AwsNative.Inputs.Tag>: The tags for the WorkSpace.
UserVolumeEncryptionEnabled bool: Indicates whether the data stored on the user volume is encrypted.
VolumeEncryptionKey string: The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
WorkspaceProperties Pulumi.AwsNative.WorkSpaces.Inputs.WorkspaceProperties: The WorkSpace properties.

BundleId string: The identifier of the bundle for the WorkSpace.
DirectoryId string: The identifier of the Directory Service directory for the WorkSpace.
UserName string: The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
RootVolumeEncryptionEnabled bool: Indicates whether the data stored on the root volume is encrypted.
Tags TagArgs: The tags for the WorkSpace.
UserVolumeEncryptionEnabled bool: Indicates whether the data stored on the user volume is encrypted.
VolumeEncryptionKey string: The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
WorkspaceProperties WorkspacePropertiesArgs: The WorkSpace properties.

bundleId String: The identifier of the bundle for the WorkSpace.
directoryId String: The identifier of the Directory Service directory for the WorkSpace.
userName String: The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
rootVolumeEncryptionEnabled Boolean: Indicates whether the data stored on the root volume is encrypted.
tags List<Tag>: The tags for the WorkSpace.
userVolumeEncryptionEnabled Boolean: Indicates whether the data stored on the user volume is encrypted.
volumeEncryptionKey String: The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
workspaceProperties WorkspaceProperties: The WorkSpace properties.

bundleId string: The identifier of the bundle for the WorkSpace.
directoryId string: The identifier of the Directory Service directory for the WorkSpace.
userName string: The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
rootVolumeEncryptionEnabled boolean: Indicates whether the data stored on the root volume is encrypted.
tags Tag[]: The tags for the WorkSpace.
userVolumeEncryptionEnabled boolean: Indicates whether the data stored on the user volume is encrypted.
volumeEncryptionKey string: The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
workspaceProperties WorkspaceProperties: The WorkSpace properties.

bundle_id str: The identifier of the bundle for the WorkSpace.
directory_id str: The identifier of the Directory Service directory for the WorkSpace.
user_name str: The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
root_volume_encryption_enabled bool: Indicates whether the data stored on the root volume is encrypted.
tags Sequence[TagArgs]: The tags for the WorkSpace.
user_volume_encryption_enabled bool: Indicates whether the data stored on the user volume is encrypted.
volume_encryption_key str: The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
workspace_properties WorkspacePropertiesArgs: The WorkSpace properties.

bundleId String: The identifier of the bundle for the WorkSpace.
directoryId String: The identifier of the Directory Service directory for the WorkSpace.
userName String: The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
rootVolumeEncryptionEnabled Boolean: Indicates whether the data stored on the root volume is encrypted.
tags List<Property Map>: The tags for the WorkSpace.
userVolumeEncryptionEnabled Boolean: Indicates whether the data stored on the user volume is encrypted.
volumeEncryptionKey String: The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
workspaceProperties Property Map: The WorkSpace properties.

Outputs

All input properties are implicitly available as output properties. Additionally, the Workspace resource produces the following output properties:

AwsId string: The identifier of the WorkSpace, returned as a string.
Id string: The provider-assigned unique ID for this managed resource.
WorkspaceId string

AwsId string: The identifier of the WorkSpace, returned as a string.
Id string: The provider-assigned unique ID for this managed resource.
WorkspaceId string

awsId String: The identifier of the WorkSpace, returned as a string.
id String: The provider-assigned unique ID for this managed resource.
workspaceId String

awsId string: The identifier of the WorkSpace, returned as a string.
id string: The provider-assigned unique ID for this managed resource.
workspaceId string

aws_id str: The identifier of the WorkSpace, returned as a string.
id str: The provider-assigned unique ID for this managed resource.
workspace_id str

awsId String: The identifier of the WorkSpace, returned as a string.
id String: The provider-assigned unique ID for this managed resource.
workspaceId String

Supporting Types

Tag, TagArgs

A set of tags to apply to the resource.

Key string: The key name of the tag
Value string: The value of the tag

Key string: The key name of the tag
Value string: The value of the tag

key String: The key name of the tag
value String: The value of the tag

key string: The key name of the tag
value string: The value of the tag

key str: The key name of the tag
value str: The value of the tag

key String: The key name of the tag
value String: The value of the tag

WorkspaceProperties, WorkspacePropertiesArgs

ComputeTypeName string: The compute type. For more information, see Amazon WorkSpaces Bundles .
RootVolumeSizeGib int: 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 .
RunningMode string: The running mode. For more information, see Manage the WorkSpace Running Mode .
RunningModeAutoStopTimeoutInMinutes int: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
UserVolumeSizeGib int: 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 .

ComputeTypeName string: The compute type. For more information, see Amazon WorkSpaces Bundles .
RootVolumeSizeGib int: 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 .
RunningMode string: The running mode. For more information, see Manage the WorkSpace Running Mode .
RunningModeAutoStopTimeoutInMinutes int: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
UserVolumeSizeGib int: 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 .

computeTypeName String: The compute type. For more information, see Amazon WorkSpaces Bundles .
rootVolumeSizeGib Integer: 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 .
runningMode String: The running mode. For more information, see Manage the WorkSpace Running Mode .
runningModeAutoStopTimeoutInMinutes Integer: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
userVolumeSizeGib Integer: 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 .

computeTypeName string: The compute type. For more information, see Amazon WorkSpaces Bundles .
rootVolumeSizeGib number: 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 .
runningMode string: The running mode. For more information, see Manage the WorkSpace Running Mode .
runningModeAutoStopTimeoutInMinutes number: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
userVolumeSizeGib number: 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 .

compute_type_name str: The compute type. For more information, see Amazon WorkSpaces Bundles .
root_volume_size_gib int: 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 str: The running mode. For more information, see Manage the WorkSpace Running Mode .
running_mode_auto_stop_timeout_in_minutes int: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
user_volume_size_gib int: 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 .

computeTypeName String: The compute type. For more information, see Amazon WorkSpaces Bundles .
rootVolumeSizeGib Number: 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 .
runningMode String: The running mode. For more information, see Manage the WorkSpace Running Mode .
runningModeAutoStopTimeoutInMinutes Number: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
userVolumeSizeGib Number: 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 .