Workspace

Provides a workspace in AWS Workspaces Service

NOTE: During deletion of an aws.workspaces.Workspace resource, the service role workspaces_DefaultRole must be attached to the policy arn:aws:iam::aws:policy/AmazonWorkSpacesServiceAccess, or it will leak the ENI that the Workspaces service creates for the Workspace.

Create a Workspace Resource

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

def Workspace(resource_name, opts=None, bundle_id=None, directory_id=None, root_volume_encryption_enabled=None, tags=None, user_name=None, user_volume_encryption_enabled=None, volume_encryption_key=None, workspace_properties=None, __props__=None);

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

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

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.
opts ResourceOptions: A bag of options that control this 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.

Workspace Resource Properties

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

Inputs

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.
UserVolumeEncryptionEnabled bool: Indicates whether the data stored on the user volume is encrypted.
VolumeEncryptionKey string: The 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 bool: Indicates whether the data stored on the root volume is encrypted.
Tags map[string]string: The tags for the WorkSpace.
UserVolumeEncryptionEnabled bool: Indicates whether the data stored on the user volume is encrypted.
VolumeEncryptionKey string: The 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.
userVolumeEncryptionEnabled boolean: Indicates whether the data stored on the user volume is encrypted.
volumeEncryptionKey string: The 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 Dict[str, str]: 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 customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
workspace_properties Dict[WorkspaceWorkspaceProperties]: 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.

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.

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.

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.

Look up an 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

static get(resource_name, id, opts=None, bundle_id=None, computer_name=None, directory_id=None, ip_address=None, root_volume_encryption_enabled=None, state=None, tags=None, user_name=None, user_volume_encryption_enabled=None, volume_encryption_key=None, workspace_properties=None, __props__=None);

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)

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.

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.
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 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 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.
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 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.
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 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 Dict[str, str]: The tags 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.
user_volume_encryption_enabled bool: Indicates whether the data stored on the user volume is encrypted.
volume_encryption_key str: The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
workspace_properties Dict[WorkspaceWorkspaceProperties]: The WorkSpace properties.

Supporting Types

WorkspaceWorkspaceProperties

See the input and output API doc for this type.

ComputeTypeName string: The compute type. For more information, see Amazon WorkSpaces Bundles. Valid values are VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO and GRAPHICSPRO.
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 and GRAPHICSPRO.
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 and GRAPHICSPRO.
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.

computeTypeName str: The compute type. For more information, see Amazon WorkSpaces Bundles. Valid values are VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO and GRAPHICSPRO.
rootVolumeSizeGib float: The size of the root volume.
runningMode str: The running mode. For more information, see Manage the WorkSpace Running Mode. Valid values are AUTO_STOP and ALWAYS_ON.
runningModeAutoStopTimeoutInMinutes float: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
userVolumeSizeGib float: The size of the user storage.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud