Package software.amazon.awscdk.services.workspacesthinclient

Class CfnEnvironment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.workspacesthinclient.CfnEnvironment
All Implemented Interfaces:
IInspectable, ITaggableV2, IEnvironmentRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:49.082Z") @Stability(Stable) public class CfnEnvironment extends CfnResource implements IInspectable, IEnvironmentRef, ITaggableV2
Describes an environment.

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.*;
 CfnEnvironment cfnEnvironment = CfnEnvironment.Builder.create(this, "MyCfnEnvironment")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEnvironment

      protected CfnEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEnvironment

      protected CfnEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEnvironment

      @Stability(Stable) public CfnEnvironment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEnvironmentProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromEnvironmentArn

      @Stability(Stable) @NotNull public static IEnvironmentRef fromEnvironmentArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IEnvironmentRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromEnvironmentId

      @Stability(Stable) @NotNull public static IEnvironmentRef fromEnvironmentId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String environmentId)
      Creates a new IEnvironmentRef from a environmentId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      environmentId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrActivationCode

      @Stability(Stable) @NotNull public String getAttrActivationCode()
      The activation code to register a device to the environment.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the environment.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp of when the environment was created.

    • getAttrDesktopType

      @Stability(Stable) @NotNull public String getAttrDesktopType()
      The type of streaming desktop for the environment.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      Unique identifier of the environment.

    • getAttrPendingSoftwareSetId

      @Stability(Stable) @NotNull public String getAttrPendingSoftwareSetId()
      The ID of the software set that is pending to be installed.

    • getAttrPendingSoftwareSetVersion

      @Stability(Stable) @NotNull public String getAttrPendingSoftwareSetVersion()
      The version of the software set that is pending to be installed.

    • getAttrRegisteredDevicesCount

      @Stability(Stable) @NotNull public Number getAttrRegisteredDevicesCount()
      The number of devices registered to the environment.

    • getAttrSoftwareSetComplianceStatus

      @Stability(Stable) @NotNull public String getAttrSoftwareSetComplianceStatus()
      Describes if the software currently installed on all devices in the environment is a supported version.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The timestamp of when the device was updated.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEnvironmentRef

      @Stability(Stable) @NotNull public EnvironmentReference getEnvironmentRef()
      A reference to a Environment resource.
      Specified by:
      getEnvironmentRef in interface IEnvironmentRef

    • getDesktopArn

      @Stability(Stable) @NotNull public String getDesktopArn()
      The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.

    • setDesktopArn

      @Stability(Stable) public void setDesktopArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.

    • getDesiredSoftwareSetId

      @Stability(Stable) @Nullable public String getDesiredSoftwareSetId()
      The ID of the software set to apply.

    • setDesiredSoftwareSetId

      @Stability(Stable) public void setDesiredSoftwareSetId(@Nullable String value)
      The ID of the software set to apply.

    • getDesktopEndpoint

      @Stability(Stable) @Nullable public String getDesktopEndpoint()
      The URL for the identity provider login (only for environments that use AppStream 2.0).

    • setDesktopEndpoint

      @Stability(Stable) public void setDesktopEndpoint(@Nullable String value)
      The URL for the identity provider login (only for environments that use AppStream 2.0).

    • getDeviceCreationTags

      @Stability(Stable) @Nullable public 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>

    • setDeviceCreationTags

      @Stability(Stable) public void setDeviceCreationTags(@Nullable IResolvable value)
      An array of key-value pairs to apply to the newly created devices for this environment.

    • setDeviceCreationTags

      @Stability(Stable) public void setDeviceCreationTags(@Nullable List<Object> value)
      An array of key-value pairs to apply to the newly created devices for this environment.

    • getKmsKeyArn

      @Stability(Stable) @Nullable public String getKmsKeyArn()
      The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.

    • setKmsKeyArn

      @Stability(Stable) public void setKmsKeyArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.

    • getMaintenanceWindow

      @Stability(Stable) @Nullable public Object getMaintenanceWindow()
      A specification for a time window to apply software updates.

      Returns union: either IResolvable or CfnEnvironment.MaintenanceWindowProperty

    • setMaintenanceWindow

      @Stability(Stable) public void setMaintenanceWindow(@Nullable IResolvable value)
      A specification for a time window to apply software updates.

    • setMaintenanceWindow

      @Stability(Stable) public void setMaintenanceWindow(@Nullable CfnEnvironment.MaintenanceWindowProperty value)
      A specification for a time window to apply software updates.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the environment.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the environment.

    • getSoftwareSetUpdateMode

      @Stability(Stable) @Nullable public String getSoftwareSetUpdateMode()
      An option to define which software updates to apply.

    • setSoftwareSetUpdateMode

      @Stability(Stable) public void setSoftwareSetUpdateMode(@Nullable String value)
      An option to define which software updates to apply.

    • getSoftwareSetUpdateSchedule

      @Stability(Stable) @Nullable public String getSoftwareSetUpdateSchedule()
      An option to define if software updates should be applied within a maintenance window.

    • setSoftwareSetUpdateSchedule

      @Stability(Stable) public void setSoftwareSetUpdateSchedule(@Nullable String value)
      An option to define if software updates should be applied within a maintenance window.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.