Class 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.

Inheritance

System.Object

Resource

CustomResource

Workspace

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Workspaces

Assembly: Pulumi.Aws.dll

Syntax

public class Workspace : CustomResource

Constructors

Workspace(String, WorkspaceArgs, CustomResourceOptions)

Create a Workspace resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
WorkspaceArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

BundleId

The ID of the bundle for the WorkSpace.

Declaration

public Output<string> BundleId { get; }

Property Value

Type	Description
Output<System.String>

ComputerName

The name of the WorkSpace, as seen by the operating system.

Declaration

public Output<string> ComputerName { get; }

Property Value

Type	Description
Output<System.String>

DirectoryId

The ID of the directory for the WorkSpace.

Declaration

public Output<string> DirectoryId { get; }

Property Value

Type	Description
Output<System.String>

IpAddress

The IP address of the WorkSpace.

Declaration

public Output<string> IpAddress { get; }

Property Value

Type	Description
Output<System.String>

RootVolumeEncryptionEnabled

Indicates whether the data stored on the root volume is encrypted.

Declaration

public Output<bool?> RootVolumeEncryptionEnabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

State

The operational state of the WorkSpace.

Declaration

public Output<string> State { get; }

Property Value

Type	Description
Output<System.String>

Tags

The tags for the WorkSpace.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

UserName

The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace.

Declaration

public Output<string> UserName { get; }

Property Value

Type	Description
Output<System.String>

UserVolumeEncryptionEnabled

Indicates whether the data stored on the user volume is encrypted.

Declaration

public Output<bool?> UserVolumeEncryptionEnabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

VolumeEncryptionKey

The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.

Declaration

public Output<string> VolumeEncryptionKey { get; }

Property Value

Type	Description
Output<System.String>

WorkspaceProperties

The WorkSpace properties.

Declaration

public Output<WorkspaceWorkspaceProperties> WorkspaceProperties { get; }

Property Value

Type	Description
Output<WorkspaceWorkspaceProperties>

Methods

Get(String, Input<String>, WorkspaceState, CustomResourceOptions)

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

Declaration

public static Workspace Get(string name, Input<string> id, WorkspaceState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
WorkspaceState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Workspace