Package software.amazon.awscdk.services.workspacesthinclient

Interface CfnEnvironmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEnvironmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:49.097Z")
@Stability(Stable)
public interface CfnEnvironmentProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.workspacesthinclient.*;
 CfnEnvironmentProps cfnEnvironmentProps = CfnEnvironmentProps.builder()
         .desktopArn("desktopArn")
         // the properties below are optional
         .desiredSoftwareSetId("desiredSoftwareSetId")
         .desktopEndpoint("desktopEndpoint")
         .deviceCreationTags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .kmsKeyArn("kmsKeyArn")
         .maintenanceWindow(MaintenanceWindowProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .applyTimeOf("applyTimeOf")
                 .daysOfTheWeek(List.of("daysOfTheWeek"))
                 .endTimeHour(123)
                 .endTimeMinute(123)
                 .startTimeHour(123)
                 .startTimeMinute(123)
                 .build())
         .name("name")
         .softwareSetUpdateMode("softwareSetUpdateMode")
         .softwareSetUpdateSchedule("softwareSetUpdateSchedule")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEnvironmentProps.Builder	A builder for CfnEnvironmentProps
static final class	CfnEnvironmentProps.Jsii$Proxy	An implementation for CfnEnvironmentProps

Method Summary

Modifier and Type	Method	Description
static CfnEnvironmentProps.Builder	builder()
default String	getDesiredSoftwareSetId()	The ID of the software set to apply.
String	getDesktopArn()	The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.
default String	getDesktopEndpoint()	The URL for the identity provider login (only for environments that use AppStream 2.0).
default Object	getDeviceCreationTags()	An array of key-value pairs to apply to the newly created devices for this environment.
default String	getKmsKeyArn()	The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.
default Object	getMaintenanceWindow()	A specification for a time window to apply software updates.
default String	getName()	The name of the environment.
default String	getSoftwareSetUpdateMode()	An option to define which software updates to apply.
default String	getSoftwareSetUpdateSchedule()	An option to define if software updates should be applied within a maintenance window.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDesktopArn

@Stability(Stable)
@NotNull
String getDesktopArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-desktoparn

getDesiredSoftwareSetId

@Stability(Stable)
@Nullable
default String getDesiredSoftwareSetId()

The ID of the software set to apply.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-desiredsoftwaresetid

getDesktopEndpoint

@Stability(Stable)
@Nullable
default String getDesktopEndpoint()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-desktopendpoint

getDeviceCreationTags

@Stability(Stable)
@Nullable
default Object getDeviceCreationTags()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTag>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-devicecreationtags

getKmsKeyArn

@Stability(Stable)
@Nullable
default String getKmsKeyArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-kmskeyarn

getMaintenanceWindow

@Stability(Stable)
@Nullable
default Object getMaintenanceWindow()

A specification for a time window to apply software updates.

Returns union: either IResolvable or CfnEnvironment.MaintenanceWindowProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-maintenancewindow

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-name

getSoftwareSetUpdateMode

@Stability(Stable)
@Nullable
default String getSoftwareSetUpdateMode()

An option to define which software updates to apply.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-softwaresetupdatemode

getSoftwareSetUpdateSchedule

@Stability(Stable)
@Nullable
default String getSoftwareSetUpdateSchedule()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-softwaresetupdateschedule

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-tags

builder

@Stability(Stable)
static CfnEnvironmentProps.Builder builder()

Returns:

a CfnEnvironmentProps.Builder of CfnEnvironmentProps