interface CfnEnvironmentProps
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.WorkSpacesThinClient.CfnEnvironmentProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsworkspacesthinclient#CfnEnvironmentProps |
Java | software.amazon.awscdk.services.workspacesthinclient.CfnEnvironmentProps |
Python | aws_cdk.aws_workspacesthinclient.CfnEnvironmentProps |
TypeScript | aws-cdk-lib » aws_workspacesthinclient » CfnEnvironmentProps |
Properties for defining a CfnEnvironment.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspacesthinclient as workspacesthinclient } from 'aws-cdk-lib';
const cfnEnvironmentProps: workspacesthinclient.CfnEnvironmentProps = {
desktopArn: 'desktopArn',
// the properties below are optional
desiredSoftwareSetId: 'desiredSoftwareSetId',
desktopEndpoint: 'desktopEndpoint',
deviceCreationTags: [{
key: 'key',
value: 'value',
}],
kmsKeyArn: 'kmsKeyArn',
maintenanceWindow: {
type: 'type',
// the properties below are optional
applyTimeOf: 'applyTimeOf',
daysOfTheWeek: ['daysOfTheWeek'],
endTimeHour: 123,
endTimeMinute: 123,
startTimeHour: 123,
startTimeMinute: 123,
},
name: 'name',
softwareSetUpdateMode: 'softwareSetUpdateMode',
softwareSetUpdateSchedule: 'softwareSetUpdateSchedule',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
| Name | Type | Description |
|---|---|---|
| desktop | string | The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or WorkSpaces Applications. |
| desired | string | The ID of the software set to apply. |
| desktop | string | The URL for the identity provider login (only for environments that use WorkSpaces Applications). |
| device | IResolvable | (IResolvable | Cfn)[] | An array of key-value pairs to apply to the newly created devices for this environment. |
| kms | string | The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment. |
| maintenance | IResolvable | Maintenance | A specification for a time window to apply software updates. |
| name? | string | The name of the environment. |
| software | string | An option to define which software updates to apply. |
| software | string | An option to define if software updates should be applied within a maintenance window. |
| tags? | Cfn[] | An array of key-value pairs to apply to this resource. |
desktopArn
Type:
string
The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or WorkSpaces Applications.
desiredSoftwareSetId?
Type:
string
(optional)
The ID of the software set to apply.
desktopEndpoint?
Type:
string
(optional)
The URL for the identity provider login (only for environments that use WorkSpaces Applications).
deviceCreationTags?
Type:
IResolvable | (IResolvable | Cfn)[]
(optional)
An array of key-value pairs to apply to the newly created devices for this environment.
kmsKeyArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.
maintenanceWindow?
Type:
IResolvable | Maintenance
(optional)
A specification for a time window to apply software updates.
name?
Type:
string
(optional)
The name of the environment.
softwareSetUpdateMode?
Type:
string
(optional)
An option to define which software updates to apply.
softwareSetUpdateSchedule?
Type:
string
(optional)
An option to define if software updates should be applied within a maintenance window.
tags?
Type:
Cfn[]
(optional)
An array of key-value pairs to apply to this resource.
For more information, see Tag .

.NET
Go
Java
Python
TypeScript