Environment

The Environment resource lets you manage AWS WorkSpacesThinClient Environments and their configuration settings.

Minimal Example

Create a basic WorkSpacesThinClient Environment with required properties and a couple of common optional properties.

import AWS from "alchemy/aws/control";

const workspaceEnvironment = await AWS.WorkSpacesThinClient.Environment("myWorkspaceEnv", {
  desktopArn: "arn:aws:workspaces:us-east-1:123456789012:desktop/my-desktop",
  desiredSoftwareSetId: "software-set-id-1234",
  name: "My Workspace Environment"
});

Advanced Configuration

Configure a WorkSpacesThinClient Environment with additional settings such as KMS key and maintenance window.

const advancedWorkspaceEnvironment = await AWS.WorkSpacesThinClient.Environment("advancedWorkspaceEnv", {
  desktopArn: "arn:aws:workspaces:us-east-1:123456789012:desktop/my-desktop",
  desiredSoftwareSetId: "software-set-id-1234",
  kmsKeyArn: "arn:aws:kms:us-east-1:123456789012:key/my-kms-key",
  maintenanceWindow: {
    startTime: "2023-10-01T00:00:00Z",
    endTime: "2023-10-01T02:00:00Z"
  },
  softwareSetUpdateMode: "AUTO",
  softwareSetUpdateSchedule: "DAILY"
});

Device Creation Tags

Create a WorkSpacesThinClient Environment with device creation tags for better organization.

const taggedWorkspaceEnvironment = await AWS.WorkSpacesThinClient.Environment("taggedWorkspaceEnv", {
  desktopArn: "arn:aws:workspaces:us-east-1:123456789012:desktop/my-desktop",
  deviceCreationTags: [
    { key: "Department", value: "Engineering" },
    { key: "Project", value: "Project Alpha" }
  ]
});

Custom Endpoint Configuration

Configure a custom desktop endpoint for the WorkSpacesThinClient Environment.

const customEndpointWorkspaceEnvironment = await AWS.WorkSpacesThinClient.Environment("customEndpointWorkspaceEnv", {
  desktopArn: "arn:aws:workspaces:us-east-1:123456789012:desktop/my-desktop",
  desktopEndpoint: "https://custom.endpoint.example.com",
  name: "Custom Endpoint Workspace Environment"
});

Adoption of Existing Resources

If you want to adopt an existing WorkSpacesThinClient Environment, specify the adopt property.

const adoptedWorkspaceEnvironment = await AWS.WorkSpacesThinClient.Environment("adoptedWorkspaceEnv", {
  desktopArn: "arn:aws:workspaces:us-east-1:123456789012:desktop/my-desktop",
  adopt: true,
  name: "Adopted Workspace Environment"
});