Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. workspaces
  5. Workspace
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

aws.workspaces.Workspace

Explore with Pulumi AI

aws logo
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

    Provides a workspace in AWS Workspaces Service

    NOTE: AWS WorkSpaces service requires workspaces_DefaultRole IAM role to operate normally.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const valueWindows10 = aws.workspaces.getBundle({
    bundleId: "wsb-bh8rsxt14",
});
const workspaces = aws.kms.getKey({
    keyId: "alias/aws/workspaces",
});
const example = new aws.workspaces.Workspace("example", {
    directoryId: exampleAwsWorkspacesDirectory.id,
    bundleId: valueWindows10.then(valueWindows10 => valueWindows10.id),
    userName: "john.doe",
    rootVolumeEncryptionEnabled: true,
    userVolumeEncryptionEnabled: true,
    volumeEncryptionKey: workspaces.then(workspaces => workspaces.arn),
    workspaceProperties: {
        computeTypeName: "VALUE",
        userVolumeSizeGib: 10,
        rootVolumeSizeGib: 80,
        runningMode: "AUTO_STOP",
        runningModeAutoStopTimeoutInMinutes: 60,
    },
    tags: {
        Department: "IT",
    },
});

    import pulumi
import pulumi_aws as aws

value_windows10 = aws.workspaces.get_bundle(bundle_id="wsb-bh8rsxt14")
workspaces = aws.kms.get_key(key_id="alias/aws/workspaces")
example = aws.workspaces.Workspace("example",
    directory_id=example_aws_workspaces_directory["id"],
    bundle_id=value_windows10.id,
    user_name="john.doe",
    root_volume_encryption_enabled=True,
    user_volume_encryption_enabled=True,
    volume_encryption_key=workspaces.arn,
    workspace_properties={
        "compute_type_name": "VALUE",
        "user_volume_size_gib": 10,
        "root_volume_size_gib": 80,
        "running_mode": "AUTO_STOP",
        "running_mode_auto_stop_timeout_in_minutes": 60,
    },
    tags={
        "Department": "IT",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kms"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/workspaces"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		valueWindows10, err := workspaces.GetBundle(ctx, &workspaces.GetBundleArgs{
			BundleId: pulumi.StringRef("wsb-bh8rsxt14"),
		}, nil)
		if err != nil {
			return err
		}
		workspaces, err := kms.LookupKey(ctx, &kms.LookupKeyArgs{
			KeyId: "alias/aws/workspaces",
		}, nil)
		if err != nil {
			return err
		}
		_, err = workspaces.NewWorkspace(ctx, "example", &workspaces.WorkspaceArgs{
			DirectoryId:                 pulumi.Any(exampleAwsWorkspacesDirectory.Id),
			BundleId:                    pulumi.String(valueWindows10.Id),
			UserName:                    pulumi.String("john.doe"),
			RootVolumeEncryptionEnabled: pulumi.Bool(true),
			UserVolumeEncryptionEnabled: pulumi.Bool(true),
			VolumeEncryptionKey:         pulumi.String(workspaces.Arn),
			WorkspaceProperties: &workspaces.WorkspaceWorkspacePropertiesArgs{
				ComputeTypeName:                     pulumi.String("VALUE"),
				UserVolumeSizeGib:                   pulumi.Int(10),
				RootVolumeSizeGib:                   pulumi.Int(80),
				RunningMode:                         pulumi.String("AUTO_STOP"),
				RunningModeAutoStopTimeoutInMinutes: pulumi.Int(60),
			},
			Tags: pulumi.StringMap{
				"Department": pulumi.String("IT"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var valueWindows10 = Aws.Workspaces.GetBundle.Invoke(new()
    {
        BundleId = "wsb-bh8rsxt14",
    });

    var workspaces = Aws.Kms.GetKey.Invoke(new()
    {
        KeyId = "alias/aws/workspaces",
    });

    var example = new Aws.Workspaces.Workspace("example", new()
    {
        DirectoryId = exampleAwsWorkspacesDirectory.Id,
        BundleId = valueWindows10.Apply(getBundleResult => getBundleResult.Id),
        UserName = "john.doe",
        RootVolumeEncryptionEnabled = true,
        UserVolumeEncryptionEnabled = true,
        VolumeEncryptionKey = workspaces.Apply(getKeyResult => getKeyResult.Arn),
        WorkspaceProperties = new Aws.Workspaces.Inputs.WorkspaceWorkspacePropertiesArgs
        {
            ComputeTypeName = "VALUE",
            UserVolumeSizeGib = 10,
            RootVolumeSizeGib = 80,
            RunningMode = "AUTO_STOP",
            RunningModeAutoStopTimeoutInMinutes = 60,
        },
        Tags = 
        {
            { "Department", "IT" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.workspaces.WorkspacesFunctions;
import com.pulumi.aws.workspaces.inputs.GetBundleArgs;
import com.pulumi.aws.kms.KmsFunctions;
import com.pulumi.aws.kms.inputs.GetKeyArgs;
import com.pulumi.aws.workspaces.Workspace;
import com.pulumi.aws.workspaces.WorkspaceArgs;
import com.pulumi.aws.workspaces.inputs.WorkspaceWorkspacePropertiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var valueWindows10 = WorkspacesFunctions.getBundle(GetBundleArgs.builder()
            .bundleId("wsb-bh8rsxt14")
            .build());

        final var workspaces = KmsFunctions.getKey(GetKeyArgs.builder()
            .keyId("alias/aws/workspaces")
            .build());

        var example = new Workspace("example", WorkspaceArgs.builder()
            .directoryId(exampleAwsWorkspacesDirectory.id())
            .bundleId(valueWindows10.id())
            .userName("john.doe")
            .rootVolumeEncryptionEnabled(true)
            .userVolumeEncryptionEnabled(true)
            .volumeEncryptionKey(workspaces.arn())
            .workspaceProperties(WorkspaceWorkspacePropertiesArgs.builder()
                .computeTypeName("VALUE")
                .userVolumeSizeGib(10)
                .rootVolumeSizeGib(80)
                .runningMode("AUTO_STOP")
                .runningModeAutoStopTimeoutInMinutes(60)
                .build())
            .tags(Map.of("Department", "IT"))
            .build());

    }
}

    resources:
  example:
    type: aws:workspaces:Workspace
    properties:
      directoryId: ${exampleAwsWorkspacesDirectory.id}
      bundleId: ${valueWindows10.id}
      userName: john.doe
      rootVolumeEncryptionEnabled: true
      userVolumeEncryptionEnabled: true
      volumeEncryptionKey: ${workspaces.arn}
      workspaceProperties:
        computeTypeName: VALUE
        userVolumeSizeGib: 10
        rootVolumeSizeGib: 80
        runningMode: AUTO_STOP
        runningModeAutoStopTimeoutInMinutes: 60
      tags:
        Department: IT
variables:
  valueWindows10:
    fn::invoke:
      function: aws:workspaces:getBundle
      arguments:
        bundleId: wsb-bh8rsxt14
  workspaces:
    fn::invoke:
      function: aws:kms:getKey
      arguments:
        keyId: alias/aws/workspaces

    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[Mapping[str, str]] = None,
              user_volume_encryption_enabled: Optional[bool] = None,
              volume_encryption_key: Optional[str] = None,
              workspace_properties: Optional[WorkspaceWorkspacePropertiesArgs] = 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: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleworkspaceResourceResourceFromWorkspacesworkspace = new Aws.Workspaces.Workspace("exampleworkspaceResourceResourceFromWorkspacesworkspace", new()
{
    BundleId = "string",
    DirectoryId = "string",
    UserName = "string",
    RootVolumeEncryptionEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
    UserVolumeEncryptionEnabled = false,
    VolumeEncryptionKey = "string",
    WorkspaceProperties = new Aws.Workspaces.Inputs.WorkspaceWorkspacePropertiesArgs
    {
        ComputeTypeName = "string",
        RootVolumeSizeGib = 0,
        RunningMode = "string",
        RunningModeAutoStopTimeoutInMinutes = 0,
        UserVolumeSizeGib = 0,
    },
});

    example, err := workspaces.NewWorkspace(ctx, "exampleworkspaceResourceResourceFromWorkspacesworkspace", &workspaces.WorkspaceArgs{
	BundleId:                    pulumi.String("string"),
	DirectoryId:                 pulumi.String("string"),
	UserName:                    pulumi.String("string"),
	RootVolumeEncryptionEnabled: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	UserVolumeEncryptionEnabled: pulumi.Bool(false),
	VolumeEncryptionKey:         pulumi.String("string"),
	WorkspaceProperties: &workspaces.WorkspaceWorkspacePropertiesArgs{
		ComputeTypeName:                     pulumi.String("string"),
		RootVolumeSizeGib:                   pulumi.Int(0),
		RunningMode:                         pulumi.String("string"),
		RunningModeAutoStopTimeoutInMinutes: pulumi.Int(0),
		UserVolumeSizeGib:                   pulumi.Int(0),
	},
})

    var exampleworkspaceResourceResourceFromWorkspacesworkspace = new com.pulumi.aws.workspaces.Workspace("exampleworkspaceResourceResourceFromWorkspacesworkspace", com.pulumi.aws.workspaces.WorkspaceArgs.builder()
    .bundleId("string")
    .directoryId("string")
    .userName("string")
    .rootVolumeEncryptionEnabled(false)
    .tags(Map.of("string", "string"))
    .userVolumeEncryptionEnabled(false)
    .volumeEncryptionKey("string")
    .workspaceProperties(WorkspaceWorkspacePropertiesArgs.builder()
        .computeTypeName("string")
        .rootVolumeSizeGib(0)
        .runningMode("string")
        .runningModeAutoStopTimeoutInMinutes(0)
        .userVolumeSizeGib(0)
        .build())
    .build());

    exampleworkspace_resource_resource_from_workspacesworkspace = aws.workspaces.Workspace("exampleworkspaceResourceResourceFromWorkspacesworkspace",
    bundle_id="string",
    directory_id="string",
    user_name="string",
    root_volume_encryption_enabled=False,
    tags={
        "string": "string",
    },
    user_volume_encryption_enabled=False,
    volume_encryption_key="string",
    workspace_properties={
        "compute_type_name": "string",
        "root_volume_size_gib": 0,
        "running_mode": "string",
        "running_mode_auto_stop_timeout_in_minutes": 0,
        "user_volume_size_gib": 0,
    })

    const exampleworkspaceResourceResourceFromWorkspacesworkspace = new aws.workspaces.Workspace("exampleworkspaceResourceResourceFromWorkspacesworkspace", {
    bundleId: "string",
    directoryId: "string",
    userName: "string",
    rootVolumeEncryptionEnabled: false,
    tags: {
        string: "string",
    },
    userVolumeEncryptionEnabled: false,
    volumeEncryptionKey: "string",
    workspaceProperties: {
        computeTypeName: "string",
        rootVolumeSizeGib: 0,
        runningMode: "string",
        runningModeAutoStopTimeoutInMinutes: 0,
        userVolumeSizeGib: 0,
    },
});

    type: aws:workspaces:Workspace
properties:
    bundleId: string
    directoryId: string
    rootVolumeEncryptionEnabled: false
    tags:
        string: string
    userName: string
    userVolumeEncryptionEnabled: false
    volumeEncryptionKey: string
    workspaceProperties:
        computeTypeName: string
        rootVolumeSizeGib: 0
        runningMode: string
        runningModeAutoStopTimeoutInMinutes: 0
        userVolumeSizeGib: 0

    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 ID of the bundle for the WorkSpace.
    DirectoryId string
    The ID of the directory for the WorkSpace.
    UserName string
    The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace.
    RootVolumeEncryptionEnabled bool
    Indicates whether the data stored on the root volume is encrypted.
    Tags Dictionary<string, string>
    The tags for the WorkSpace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    UserVolumeEncryptionEnabled bool
    Indicates whether the data stored on the user volume is encrypted.
    VolumeEncryptionKey string
    The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
    WorkspaceProperties WorkspaceWorkspaceProperties
    The WorkSpace properties.
    BundleId string
    The ID of the bundle for the WorkSpace.
    DirectoryId string
    The ID of the directory for the WorkSpace.
    UserName string
    The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace.
    RootVolumeEncryptionEnabled bool
    Indicates whether the data stored on the root volume is encrypted.
    Tags map[string]string
    The tags for the WorkSpace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    UserVolumeEncryptionEnabled bool
    Indicates whether the data stored on the user volume is encrypted.
    VolumeEncryptionKey string
    The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
    WorkspaceProperties WorkspaceWorkspacePropertiesArgs
    The WorkSpace properties.
    bundleId String
    The ID of the bundle for the WorkSpace.
    directoryId String
    The ID of the directory for the WorkSpace.
    userName String
    The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace.
    rootVolumeEncryptionEnabled Boolean
    Indicates whether the data stored on the root volume is encrypted.
    tags Map<String,String>
    The tags for the WorkSpace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    userVolumeEncryptionEnabled Boolean
    Indicates whether the data stored on the user volume is encrypted.
    volumeEncryptionKey String
    The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
    workspaceProperties WorkspaceWorkspaceProperties
    The WorkSpace properties.
    bundleId string
    The ID of the bundle for the WorkSpace.
    directoryId string
    The ID of the directory for the WorkSpace.
    userName string
    The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace.
    rootVolumeEncryptionEnabled boolean
    Indicates whether the data stored on the root volume is encrypted.
    tags {[key: string]: string}
    The tags for the WorkSpace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    userVolumeEncryptionEnabled boolean
    Indicates whether the data stored on the user volume is encrypted.
    volumeEncryptionKey string
    The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
    workspaceProperties WorkspaceWorkspaceProperties
    The WorkSpace properties.
    bundle_id str
    The ID of the bundle for the WorkSpace.
    directory_id str
    The ID of the directory for the WorkSpace.
    user_name str
    The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace.
    root_volume_encryption_enabled bool
    Indicates whether the data stored on the root volume is encrypted.
    tags Mapping[str, str]
    The tags for the WorkSpace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    user_volume_encryption_enabled bool
    Indicates whether the data stored on the user volume is encrypted.
    volume_encryption_key str
    The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
    workspace_properties WorkspaceWorkspacePropertiesArgs
    The WorkSpace properties.
    bundleId String
    The ID of the bundle for the WorkSpace.
    directoryId String
    The ID of the directory for the WorkSpace.
    userName String
    The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace.
    rootVolumeEncryptionEnabled Boolean
    Indicates whether the data stored on the root volume is encrypted.
    tags Map<String>
    The tags for the WorkSpace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    userVolumeEncryptionEnabled Boolean
    Indicates whether the data stored on the user volume is encrypted.
    volumeEncryptionKey String
    The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
    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:

    ComputerName string
    The name of the WorkSpace, as seen by the operating system.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    The IP address of the WorkSpace.
    State string
    The operational state of the WorkSpace.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    ComputerName string
    The name of the WorkSpace, as seen by the operating system.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    The IP address of the WorkSpace.
    State string
    The operational state of the WorkSpace.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    computerName String
    The name of the WorkSpace, as seen by the operating system.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    The IP address of the WorkSpace.
    state String
    The operational state of the WorkSpace.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    computerName string
    The name of the WorkSpace, as seen by the operating system.
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddress string
    The IP address of the WorkSpace.
    state string
    The operational state of the WorkSpace.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    computer_name str
    The name of the WorkSpace, as seen by the operating system.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_address str
    The IP address of the WorkSpace.
    state str
    The operational state of the WorkSpace.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    computerName String
    The name of the WorkSpace, as seen by the operating system.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    The IP address of the WorkSpace.
    state String
    The operational state of the WorkSpace.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Workspace Resource

    Get an existing Workspace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WorkspaceState, opts?: CustomResourceOptions): Workspace
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bundle_id: Optional[str] = None,
        computer_name: Optional[str] = None,
        directory_id: Optional[str] = None,
        ip_address: Optional[str] = None,
        root_volume_encryption_enabled: Optional[bool] = None,
        state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        user_name: Optional[str] = None,
        user_volume_encryption_enabled: Optional[bool] = None,
        volume_encryption_key: Optional[str] = None,
        workspace_properties: Optional[WorkspaceWorkspacePropertiesArgs] = None) -> Workspace
    func GetWorkspace(ctx *Context, name string, id IDInput, state *WorkspaceState, opts ...ResourceOption) (*Workspace, error)
    public static Workspace Get(string name, Input<string> id, WorkspaceState? state, CustomResourceOptions? opts = null)
    public static Workspace get(String name, Output<String> id, WorkspaceState state, CustomResourceOptions options)
    resources:  _:    type: aws:workspaces:Workspace    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BundleId string
    The ID of the bundle for the WorkSpace.
    ComputerName string
    The name of the WorkSpace, as seen by the operating system.
    DirectoryId string
    The ID of the directory for the WorkSpace.
    IpAddress string
    The IP address of the WorkSpace.
    RootVolumeEncryptionEnabled bool
    Indicates whether the data stored on the root volume is encrypted.
    State string
    The operational state of the WorkSpace.
    Tags Dictionary<string, string>
    The tags for the WorkSpace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UserName string
    The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace.
    UserVolumeEncryptionEnabled bool
    Indicates whether the data stored on the user volume is encrypted.
    VolumeEncryptionKey string
    The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
    WorkspaceProperties WorkspaceWorkspaceProperties
    The WorkSpace properties.
    BundleId string
    The ID of the bundle for the WorkSpace.
    ComputerName string
    The name of the WorkSpace, as seen by the operating system.
    DirectoryId string
    The ID of the directory for the WorkSpace.
    IpAddress string
    The IP address of the WorkSpace.
    RootVolumeEncryptionEnabled bool
    Indicates whether the data stored on the root volume is encrypted.
    State string
    The operational state of the WorkSpace.
    Tags map[string]string
    The tags for the WorkSpace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UserName string
    The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace.
    UserVolumeEncryptionEnabled bool
    Indicates whether the data stored on the user volume is encrypted.
    VolumeEncryptionKey string
    The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
    WorkspaceProperties WorkspaceWorkspacePropertiesArgs
    The WorkSpace properties.
    bundleId String
    The ID of the bundle for the WorkSpace.
    computerName String
    The name of the WorkSpace, as seen by the operating system.
    directoryId String
    The ID of the directory for the WorkSpace.
    ipAddress String
    The IP address of the WorkSpace.
    rootVolumeEncryptionEnabled Boolean
    Indicates whether the data stored on the root volume is encrypted.
    state String
    The operational state of the WorkSpace.
    tags Map<String,String>
    The tags for the WorkSpace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    userName String
    The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace.
    userVolumeEncryptionEnabled Boolean
    Indicates whether the data stored on the user volume is encrypted.
    volumeEncryptionKey String
    The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
    workspaceProperties WorkspaceWorkspaceProperties
    The WorkSpace properties.
    bundleId string
    The ID of the bundle for the WorkSpace.
    computerName string
    The name of the WorkSpace, as seen by the operating system.
    directoryId string
    The ID of the directory for the WorkSpace.
    ipAddress string
    The IP address of the WorkSpace.
    rootVolumeEncryptionEnabled boolean
    Indicates whether the data stored on the root volume is encrypted.
    state string
    The operational state of the WorkSpace.
    tags {[key: string]: string}
    The tags for the WorkSpace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    userName string
    The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace.
    userVolumeEncryptionEnabled boolean
    Indicates whether the data stored on the user volume is encrypted.
    volumeEncryptionKey string
    The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
    workspaceProperties WorkspaceWorkspaceProperties
    The WorkSpace properties.
    bundle_id str
    The ID of the bundle for the WorkSpace.
    computer_name str
    The name of the WorkSpace, as seen by the operating system.
    directory_id str
    The ID of the directory for the WorkSpace.
    ip_address str
    The IP address of the WorkSpace.
    root_volume_encryption_enabled bool
    Indicates whether the data stored on the root volume is encrypted.
    state str
    The operational state of the WorkSpace.
    tags Mapping[str, str]
    The tags for the WorkSpace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    user_name str
    The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace.
    user_volume_encryption_enabled bool
    Indicates whether the data stored on the user volume is encrypted.
    volume_encryption_key str
    The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
    workspace_properties WorkspaceWorkspacePropertiesArgs
    The WorkSpace properties.
    bundleId String
    The ID of the bundle for the WorkSpace.
    computerName String
    The name of the WorkSpace, as seen by the operating system.
    directoryId String
    The ID of the directory for the WorkSpace.
    ipAddress String
    The IP address of the WorkSpace.
    rootVolumeEncryptionEnabled Boolean
    Indicates whether the data stored on the root volume is encrypted.
    state String
    The operational state of the WorkSpace.
    tags Map<String>
    The tags for the WorkSpace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    userName String
    The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace.
    userVolumeEncryptionEnabled Boolean
    Indicates whether the data stored on the user volume is encrypted.
    volumeEncryptionKey String
    The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
    workspaceProperties Property Map
    The WorkSpace properties.

    Supporting Types

    WorkspaceWorkspaceProperties, WorkspaceWorkspacePropertiesArgs

    ComputeTypeName string
    The compute type. For more information, see Amazon WorkSpaces Bundles. Valid values are VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO, GRAPHICS_G4DN, and GRAPHICSPRO_G4DN.
    RootVolumeSizeGib int
    The size of the root volume.
    RunningMode string
    The running mode. For more information, see Manage the WorkSpace Running Mode. Valid values are AUTO_STOP and ALWAYS_ON.
    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.
    ComputeTypeName string
    The compute type. For more information, see Amazon WorkSpaces Bundles. Valid values are VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO, GRAPHICS_G4DN, and GRAPHICSPRO_G4DN.
    RootVolumeSizeGib int
    The size of the root volume.
    RunningMode string
    The running mode. For more information, see Manage the WorkSpace Running Mode. Valid values are AUTO_STOP and ALWAYS_ON.
    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.
    computeTypeName String
    The compute type. For more information, see Amazon WorkSpaces Bundles. Valid values are VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO, GRAPHICS_G4DN, and GRAPHICSPRO_G4DN.
    rootVolumeSizeGib Integer
    The size of the root volume.
    runningMode String
    The running mode. For more information, see Manage the WorkSpace Running Mode. Valid values are AUTO_STOP and ALWAYS_ON.
    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.
    computeTypeName string
    The compute type. For more information, see Amazon WorkSpaces Bundles. Valid values are VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO, GRAPHICS_G4DN, and GRAPHICSPRO_G4DN.
    rootVolumeSizeGib number
    The size of the root volume.
    runningMode string
    The running mode. For more information, see Manage the WorkSpace Running Mode. Valid values are AUTO_STOP and ALWAYS_ON.
    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.
    compute_type_name str
    The compute type. For more information, see Amazon WorkSpaces Bundles. Valid values are VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO, GRAPHICS_G4DN, and GRAPHICSPRO_G4DN.
    root_volume_size_gib int
    The size of the root volume.
    running_mode str
    The running mode. For more information, see Manage the WorkSpace Running Mode. Valid values are AUTO_STOP and ALWAYS_ON.
    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.
    computeTypeName String
    The compute type. For more information, see Amazon WorkSpaces Bundles. Valid values are VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO, GRAPHICS_G4DN, and GRAPHICSPRO_G4DN.
    rootVolumeSizeGib Number
    The size of the root volume.
    runningMode String
    The running mode. For more information, see Manage the WorkSpace Running Mode. Valid values are AUTO_STOP and ALWAYS_ON.
    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.

    Import

    Using pulumi import, import Workspaces using their ID. For example:

    $ pulumi import aws:workspaces/workspace:Workspace example ws-9z9zmbkhv

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
    pulumi/pulumi-aws