AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::WorkSpacesThinClient::Environment

CfnEnvironment

Describes an environment.

Import

import { CfnEnvironment } from 'aws-cdk-lib/aws-workspacesthinclient';

Or use the module namespace:

import * as workspacesthinclient from 'aws-cdk-lib/aws-workspacesthinclient';
// workspacesthinclient.CfnEnvironment

Properties

Configuration passed to the constructor as CfnEnvironmentProps.

desktopArnRequired
string

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

desiredSoftwareSetIdOptional
string

The ID of the software set to apply.

desktopEndpointOptional
string

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

deviceCreationTagsOptional
IResolvable | IResolvable | CfnTag[]

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

kmsKeyArnOptional
string

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

maintenanceWindowOptional
IResolvable | MaintenanceWindowProperty

A specification for a time window to apply software updates.

nameOptional
string

The name of the environment.

softwareSetUpdateModeOptional
string

An option to define which software updates to apply.

softwareSetUpdateScheduleOptional
string

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

tagsOptional
CfnTag[]

An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::WorkSpacesThinClient::EnvironmentView in CloudFormation Explorer

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

LevelL1 (CloudFormation)
Moduleaws-workspacesthinclient
CFN TypeAWS::WorkSpacesThinClient::Environment
Properties10

Explore This Service

External Links