AWS::WorkSpacesThinClient::Environment

WorkSpacesThinClient Environment

Resource type definition for AWS::WorkSpacesThinClient::Environment.

Properties

10 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`DesktopArn`	`string`	RequiredCreate-only
`DesiredSoftwareSetId`	`string`
`DesktopEndpoint`	`string`
`DeviceCreationTags`	`Array<Tag>`
`KmsKeyArn`	`string`	Create-only
`MaintenanceWindow`	`MaintenanceWindow`
`Name`	`string`
`SoftwareSetUpdateMode`	`string`
`SoftwareSetUpdateSchedule`	`string`
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`ActivationCode`	`string`	Activation code for devices associated with environment.
`Arn`	`string`	The environment ARN.
`CreatedAt`	`string`	The timestamp in unix epoch format when environment was created.
`DesktopType`	`string`	The type of VDI.
`Id`	`string`	Unique identifier of the environment.
`PendingSoftwareSetId`	`string`	The ID of the software set that is pending to be installed.
`PendingSoftwareSetVersion`	`string`	The version of the software set that is pending to be installed.
`RegisteredDevicesCount`	`integer`	Number of devices registered to the environment.
`SoftwareSetComplianceStatus`	`string`	Describes if the software currently installed on all devices in the environment is a supported version.
`UpdatedAt`	`string`	The timestamp in unix epoch format when environment was last updated.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::WorkSpacesThinClient::Environment

Resources:
  MyResource:
    Type: AWS::WorkSpacesThinClient::Environment
    Properties:
      DesktopArn: "arn:aws:service:region:account:resource"
      Tags:
        - Key: Environment
          Value: Production
      Name: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

thinclient:CreateEnvironmentthinclient:TagResourcethinclient:ListTagsForResourceappstream:DescribeStacksworkspaces:DescribeWorkspaceDirectoriesworkspaces-web:GetPortalworkspaces-web:GetUserSettingskms:DescribeKey

read

thinclient:GetEnvironmentthinclient:ListTagsForResourcekms:Decrypt

update

appstream:DescribeStacksworkspaces:DescribeWorkspaceDirectoriesworkspaces-web:GetPortalworkspaces-web:GetUserSettingsthinclient:UpdateEnvironmentthinclient:TagResourcethinclient:UntagResourcekms:Decrypt

delete

thinclient:DeleteEnvironmentthinclient:UntagResourcekms:Decryptkms:RetireGrant

list

thinclient:ListEnvironmentsthinclient:ListTagsForResourcekms:Decrypt

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceWorkSpacesThinClient

Properties20

Required1

TaggingSupported

Primary IDId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

KmsKeyArnDesktopArn

External Links

AWS Documentation