Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. workspacesthinclient
  5. getEnvironment

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.workspacesthinclient.getEnvironment

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource type definition for AWS::WorkSpacesThinClient::Environment.

Using getEnvironment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>
Copy
def get_environment(id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentResult]
Copy
func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput
Copy

> Note: This function is named LookupEnvironment in the Go SDK.

public static class GetEnvironment 
{
    public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
public static Output<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:workspacesthinclient:getEnvironment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
Unique identifier of the environment.
Id This property is required. string
Unique identifier of the environment.
id This property is required. String
Unique identifier of the environment.
id This property is required. string
Unique identifier of the environment.
id This property is required. str
Unique identifier of the environment.
id This property is required. String
Unique identifier of the environment.

getEnvironment Result

The following output properties are available:

ActivationCode string
Activation code for devices associated with environment.
Arn string
The environment ARN.
CreatedAt string
The timestamp in unix epoch format when environment was created.
DesiredSoftwareSetId string
The ID of the software set to apply.
DesktopEndpoint string
The URL for the identity provider login (only for environments that use AppStream 2.0).
DesktopType Pulumi.AwsNative.WorkSpacesThinClient.EnvironmentDesktopType
The type of VDI.
DeviceCreationTags List<Pulumi.AwsNative.WorkSpacesThinClient.Outputs.EnvironmentTag>
An array of key-value pairs to apply to the newly created devices for this environment.
Id string
Unique identifier of the environment.
MaintenanceWindow Pulumi.AwsNative.WorkSpacesThinClient.Outputs.EnvironmentMaintenanceWindow
A specification for a time window to apply software updates.
Name string
The name of the environment.
PendingSoftwareSetId string
The ID of the software set that is pending to be installed.
PendingSoftwareSetVersion string
The version of the software set that is pending to be installed.
RegisteredDevicesCount int
Number of devices registered to the environment.
SoftwareSetComplianceStatus Pulumi.AwsNative.WorkSpacesThinClient.EnvironmentSoftwareSetComplianceStatus
Describes if the software currently installed on all devices in the environment is a supported version.
SoftwareSetUpdateMode Pulumi.AwsNative.WorkSpacesThinClient.EnvironmentSoftwareSetUpdateMode
An option to define which software updates to apply.
SoftwareSetUpdateSchedule Pulumi.AwsNative.WorkSpacesThinClient.EnvironmentSoftwareSetUpdateSchedule
An option to define if software updates should be applied within a maintenance window.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this resource.
UpdatedAt string
The timestamp in unix epoch format when environment was last updated.
ActivationCode string
Activation code for devices associated with environment.
Arn string
The environment ARN.
CreatedAt string
The timestamp in unix epoch format when environment was created.
DesiredSoftwareSetId string
The ID of the software set to apply.
DesktopEndpoint string
The URL for the identity provider login (only for environments that use AppStream 2.0).
DesktopType EnvironmentDesktopType
The type of VDI.
DeviceCreationTags []EnvironmentTag
An array of key-value pairs to apply to the newly created devices for this environment.
Id string
Unique identifier of the environment.
MaintenanceWindow EnvironmentMaintenanceWindow
A specification for a time window to apply software updates.
Name string
The name of the environment.
PendingSoftwareSetId string
The ID of the software set that is pending to be installed.
PendingSoftwareSetVersion string
The version of the software set that is pending to be installed.
RegisteredDevicesCount int
Number of devices registered to the environment.
SoftwareSetComplianceStatus EnvironmentSoftwareSetComplianceStatus
Describes if the software currently installed on all devices in the environment is a supported version.
SoftwareSetUpdateMode EnvironmentSoftwareSetUpdateMode
An option to define which software updates to apply.
SoftwareSetUpdateSchedule EnvironmentSoftwareSetUpdateSchedule
An option to define if software updates should be applied within a maintenance window.
Tags Tag
An array of key-value pairs to apply to this resource.
UpdatedAt string
The timestamp in unix epoch format when environment was last updated.
activationCode String
Activation code for devices associated with environment.
arn String
The environment ARN.
createdAt String
The timestamp in unix epoch format when environment was created.
desiredSoftwareSetId String
The ID of the software set to apply.
desktopEndpoint String
The URL for the identity provider login (only for environments that use AppStream 2.0).
desktopType EnvironmentDesktopType
The type of VDI.
deviceCreationTags List<EnvironmentTag>
An array of key-value pairs to apply to the newly created devices for this environment.
id String
Unique identifier of the environment.
maintenanceWindow EnvironmentMaintenanceWindow
A specification for a time window to apply software updates.
name String
The name of the environment.
pendingSoftwareSetId String
The ID of the software set that is pending to be installed.
pendingSoftwareSetVersion String
The version of the software set that is pending to be installed.
registeredDevicesCount Integer
Number of devices registered to the environment.
softwareSetComplianceStatus EnvironmentSoftwareSetComplianceStatus
Describes if the software currently installed on all devices in the environment is a supported version.
softwareSetUpdateMode EnvironmentSoftwareSetUpdateMode
An option to define which software updates to apply.
softwareSetUpdateSchedule EnvironmentSoftwareSetUpdateSchedule
An option to define if software updates should be applied within a maintenance window.
tags List<Tag>
An array of key-value pairs to apply to this resource.
updatedAt String
The timestamp in unix epoch format when environment was last updated.
activationCode string
Activation code for devices associated with environment.
arn string
The environment ARN.
createdAt string
The timestamp in unix epoch format when environment was created.
desiredSoftwareSetId string
The ID of the software set to apply.
desktopEndpoint string
The URL for the identity provider login (only for environments that use AppStream 2.0).
desktopType EnvironmentDesktopType
The type of VDI.
deviceCreationTags EnvironmentTag[]
An array of key-value pairs to apply to the newly created devices for this environment.
id string
Unique identifier of the environment.
maintenanceWindow EnvironmentMaintenanceWindow
A specification for a time window to apply software updates.
name string
The name of the environment.
pendingSoftwareSetId string
The ID of the software set that is pending to be installed.
pendingSoftwareSetVersion string
The version of the software set that is pending to be installed.
registeredDevicesCount number
Number of devices registered to the environment.
softwareSetComplianceStatus EnvironmentSoftwareSetComplianceStatus
Describes if the software currently installed on all devices in the environment is a supported version.
softwareSetUpdateMode EnvironmentSoftwareSetUpdateMode
An option to define which software updates to apply.
softwareSetUpdateSchedule EnvironmentSoftwareSetUpdateSchedule
An option to define if software updates should be applied within a maintenance window.
tags Tag[]
An array of key-value pairs to apply to this resource.
updatedAt string
The timestamp in unix epoch format when environment was last updated.
activation_code str
Activation code for devices associated with environment.
arn str
The environment ARN.
created_at str
The timestamp in unix epoch format when environment was created.
desired_software_set_id str
The ID of the software set to apply.
desktop_endpoint str
The URL for the identity provider login (only for environments that use AppStream 2.0).
desktop_type EnvironmentDesktopType
The type of VDI.
device_creation_tags Sequence[EnvironmentTag]
An array of key-value pairs to apply to the newly created devices for this environment.
id str
Unique identifier of the environment.
maintenance_window EnvironmentMaintenanceWindow
A specification for a time window to apply software updates.
name str
The name of the environment.
pending_software_set_id str
The ID of the software set that is pending to be installed.
pending_software_set_version str
The version of the software set that is pending to be installed.
registered_devices_count int
Number of devices registered to the environment.
software_set_compliance_status EnvironmentSoftwareSetComplianceStatus
Describes if the software currently installed on all devices in the environment is a supported version.
software_set_update_mode EnvironmentSoftwareSetUpdateMode
An option to define which software updates to apply.
software_set_update_schedule EnvironmentSoftwareSetUpdateSchedule
An option to define if software updates should be applied within a maintenance window.
tags Sequence[root_Tag]
An array of key-value pairs to apply to this resource.
updated_at str
The timestamp in unix epoch format when environment was last updated.
activationCode String
Activation code for devices associated with environment.
arn String
The environment ARN.
createdAt String
The timestamp in unix epoch format when environment was created.
desiredSoftwareSetId String
The ID of the software set to apply.
desktopEndpoint String
The URL for the identity provider login (only for environments that use AppStream 2.0).
desktopType "workspaces" | "appstream" | "workspaces-web"
The type of VDI.
deviceCreationTags List<Property Map>
An array of key-value pairs to apply to the newly created devices for this environment.
id String
Unique identifier of the environment.
maintenanceWindow Property Map
A specification for a time window to apply software updates.
name String
The name of the environment.
pendingSoftwareSetId String
The ID of the software set that is pending to be installed.
pendingSoftwareSetVersion String
The version of the software set that is pending to be installed.
registeredDevicesCount Number
Number of devices registered to the environment.
softwareSetComplianceStatus "COMPLIANT" | "NOT_COMPLIANT" | "NO_REGISTERED_DEVICES"
Describes if the software currently installed on all devices in the environment is a supported version.
softwareSetUpdateMode "USE_LATEST" | "USE_DESIRED"
An option to define which software updates to apply.
softwareSetUpdateSchedule "USE_MAINTENANCE_WINDOW" | "APPLY_IMMEDIATELY"
An option to define if software updates should be applied within a maintenance window.
tags List<Property Map>
An array of key-value pairs to apply to this resource.
updatedAt String
The timestamp in unix epoch format when environment was last updated.

Supporting Types

EnvironmentDayOfWeek

EnvironmentDesktopType

EnvironmentMaintenanceWindow

Type This property is required. Pulumi.AwsNative.WorkSpacesThinClient.EnvironmentMaintenanceWindowType
The type of maintenance window.
ApplyTimeOf Pulumi.AwsNative.WorkSpacesThinClient.EnvironmentMaintenanceWindowApplyTimeOf
The desired time zone maintenance window.
DaysOfTheWeek List<Pulumi.AwsNative.WorkSpacesThinClient.EnvironmentDayOfWeek>
The date of maintenance window.
EndTimeHour int
The hour end time of maintenance window.
EndTimeMinute int
The minute end time of maintenance window.
StartTimeHour int
The hour start time of maintenance window.
StartTimeMinute int
The minute start time of maintenance window.
Type This property is required. EnvironmentMaintenanceWindowType
The type of maintenance window.
ApplyTimeOf EnvironmentMaintenanceWindowApplyTimeOf
The desired time zone maintenance window.
DaysOfTheWeek []EnvironmentDayOfWeek
The date of maintenance window.
EndTimeHour int
The hour end time of maintenance window.
EndTimeMinute int
The minute end time of maintenance window.
StartTimeHour int
The hour start time of maintenance window.
StartTimeMinute int
The minute start time of maintenance window.
type This property is required. EnvironmentMaintenanceWindowType
The type of maintenance window.
applyTimeOf EnvironmentMaintenanceWindowApplyTimeOf
The desired time zone maintenance window.
daysOfTheWeek List<EnvironmentDayOfWeek>
The date of maintenance window.
endTimeHour Integer
The hour end time of maintenance window.
endTimeMinute Integer
The minute end time of maintenance window.
startTimeHour Integer
The hour start time of maintenance window.
startTimeMinute Integer
The minute start time of maintenance window.
type This property is required. EnvironmentMaintenanceWindowType
The type of maintenance window.
applyTimeOf EnvironmentMaintenanceWindowApplyTimeOf
The desired time zone maintenance window.
daysOfTheWeek EnvironmentDayOfWeek[]
The date of maintenance window.
endTimeHour number
The hour end time of maintenance window.
endTimeMinute number
The minute end time of maintenance window.
startTimeHour number
The hour start time of maintenance window.
startTimeMinute number
The minute start time of maintenance window.
type This property is required. EnvironmentMaintenanceWindowType
The type of maintenance window.
apply_time_of EnvironmentMaintenanceWindowApplyTimeOf
The desired time zone maintenance window.
days_of_the_week Sequence[EnvironmentDayOfWeek]
The date of maintenance window.
end_time_hour int
The hour end time of maintenance window.
end_time_minute int
The minute end time of maintenance window.
start_time_hour int
The hour start time of maintenance window.
start_time_minute int
The minute start time of maintenance window.
type This property is required. "SYSTEM" | "CUSTOM"
The type of maintenance window.
applyTimeOf "UTC" | "DEVICE"
The desired time zone maintenance window.
daysOfTheWeek List<"MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY">
The date of maintenance window.
endTimeHour Number
The hour end time of maintenance window.
endTimeMinute Number
The minute end time of maintenance window.
startTimeHour Number
The hour start time of maintenance window.
startTimeMinute Number
The minute start time of maintenance window.

EnvironmentMaintenanceWindowApplyTimeOf

EnvironmentMaintenanceWindowType

EnvironmentSoftwareSetComplianceStatus

EnvironmentSoftwareSetUpdateMode

EnvironmentSoftwareSetUpdateSchedule

EnvironmentTag

Key This property is required. string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value This property is required. string
The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Key This property is required. string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value This property is required. string
The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
key This property is required. String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value This property is required. String
The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
key This property is required. string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value This property is required. string
The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
key This property is required. str
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value This property is required. str
The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
key This property is required. String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value This property is required. String
The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native