Environment

Describes an environment.

activationCode

The activation code to register a device to the environment.

Type: String

Pattern: [a-z]{2}[a-z0-9]{6}

Required: No

arn

The Amazon Resource Name (ARN) of the environment.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

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

Required: No

createdAt

The timestamp of when the environment was created.

Type: Timestamp

Required: No

desiredSoftwareSetId

The ID of the software set to apply.

Type: String

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

Required: No

desktopArn

The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

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

Required: No

desktopEndpoint

The URL for the identity provider login (only for environments that use AppStream 2.0).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

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

Required: No

desktopType

The type of streaming desktop for the environment.

Type: String

Valid Values: workspaces | appstream | workspaces-web

Required: No

deviceCreationTags

The tag keys and optional values for the newly created devices for this environment.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: (?!aws:)[A-Za-z0-9 _=@:.+-/]+

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: [A-Za-z0-9 _=@:.+-/]+

Required: No

id

The ID of the environment.

Type: String

Pattern: [a-z0-9]{9}

Required: No

kmsKeyArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

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

Required: No

maintenanceWindow

A specification for a time window to apply software updates.

Type: MaintenanceWindow object

Required: No

name

The name of the environment.

Type: String

Pattern: [0-9\p{IsAlphabetic}+:,.@'" -][0-9\p{IsAlphabetic}+=:,.@'" -]{0,63}

Required: No

pendingSoftwareSetId

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

Type: String

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

Required: No

pendingSoftwareSetVersion

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

Type: String

Required: No

registeredDevicesCount

The number of devices registered to the environment.

Type: Integer

Required: No

softwareSetComplianceStatus

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

Type: String

Valid Values: NO_REGISTERED_DEVICES | COMPLIANT | NOT_COMPLIANT

Required: No

softwareSetUpdateMode

An option to define which software updates to apply.

Type: String

Valid Values: USE_LATEST | USE_DESIRED

Required: No

softwareSetUpdateSchedule

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

Type: String

Valid Values: USE_MAINTENANCE_WINDOW | APPLY_IMMEDIATELY

Required: No

tags

The tag keys and optional values for the resource.

Type: String to string map

Required: No

updatedAt

The timestamp of when the device was updated.

Type: Timestamp

Required: No

Environment

Contents

See Also