AWS::WorkSpacesThinClient::Environment - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::WorkSpacesThinClient::Environment

Important

End of support notice: On March 31, 2027, Amazon will end support for Amazon WorkSpaces Thin Client. After March 31, 2027, you will no longer be able to access the WorkSpaces Thin Client console or WorkSpaces Thin Client resources. For more information, see Amazon WorkSpaces Thin Client end of support.

Describes an environment.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::WorkSpacesThinClient::Environment",
  "Properties" : {
      "DesiredSoftwareSetId" : String,
      "DesktopArn" : String,
      "DesktopEndpoint" : String,
      "DeviceCreationTags" : [ Tag, ... ],
      "KmsKeyArn" : String,
      "MaintenanceWindow" : MaintenanceWindow,
      "Name" : String,
      "SoftwareSetUpdateMode" : String,
      "SoftwareSetUpdateSchedule" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::WorkSpacesThinClient::Environment
Properties:
  DesiredSoftwareSetId: String
  DesktopArn: String
  DesktopEndpoint: String
  DeviceCreationTags: 
    - Tag
  KmsKeyArn: String
  MaintenanceWindow: 
    MaintenanceWindow
  Name: String
  SoftwareSetUpdateMode: String
  SoftwareSetUpdateSchedule: String
  Tags: 
    - Tag

Properties

DesiredSoftwareSetId

The ID of the software set to apply.

Required: No

Type: String

Pattern: ^[0-9]{1,9}$

Update requires: No interruption

DesktopArn

The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or WorkSpaces Applications.

Required: Yes

Type: String

Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[0-9]{0,12}:[a-zA-Z0-9\-\/\._]+$

Minimum: 20

Maximum: 2048

Update requires: Replacement

DesktopEndpoint

The URL for the identity provider login (only for environments that use WorkSpaces Applications).

Required: No

Type: String

Pattern: ^(https:\/\/)[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,32}(:[0-9]{1,5})?(\/.*)?$

Minimum: 1

Maximum: 1024

Update requires: No interruption

DeviceCreationTags

An array of key-value pairs to apply to the newly created devices for this environment.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

KmsKeyArn

The Amazon Resource Name (ARN) of the Amazon Key Management Service key used to encrypt the environment.

Required: No

Type: String

Pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[0-9]{0,12}:key\/[a-zA-Z0-9-]+$

Minimum: 20

Maximum: 2048

Update requires: Replacement

MaintenanceWindow

A specification for a time window to apply software updates.

Required: No

Type: MaintenanceWindow

Update requires: No interruption

Name

The name of the environment.

Required: No

Type: String

Pattern: ^.+$

Minimum: 1

Maximum: 64

Update requires: No interruption

SoftwareSetUpdateMode

An option to define which software updates to apply.

Required: No

Type: String

Allowed values: USE_LATEST | USE_DESIRED

Update requires: No interruption

SoftwareSetUpdateSchedule

An option to define if software updates should be applied within a maintenance window.

Required: No

Type: String

Allowed values: USE_MAINTENANCE_WINDOW | APPLY_IMMEDIATELY

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a unique identifier for this resource.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ActivationCode

The activation code to register a device to the environment.

Arn

The Amazon Resource Name (ARN) of the environment.

CreatedAt

The timestamp of when the environment was created.

DesktopType

The type of streaming desktop for the environment.

PendingSoftwareSetId

The ID of the software set that is pending to be installed.

PendingSoftwareSetVersion

The version of the software set that is pending to be installed.

RegisteredDevicesCount

The number of devices registered to the environment.

SoftwareSetComplianceStatus

Describes if the software currently installed on all devices in the environment is a supported version.

UpdatedAt

The timestamp of when the device was updated.