AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon WorkSpaces Thin Client CreateEnvironment API operation.

Syntax

New-WSTCEnvironment
-DesktopArn <String>
-MaintenanceWindow_ApplyTimeOf <ApplyTimeOf>
-MaintenanceWindow_DaysOfTheWeek <String[]>
-DesiredSoftwareSetId <String>
-DesktopEndpoint <String>
-DeviceCreationTag <Hashtable>
-MaintenanceWindow_EndTimeHour <Int32>
-MaintenanceWindow_EndTimeMinute <Int32>
-KmsKeyArn <String>
-Name <String>
-SoftwareSetUpdateMode <SoftwareSetUpdateMode>
-SoftwareSetUpdateSchedule <SoftwareSetUpdateSchedule>
-MaintenanceWindow_StartTimeHour <Int32>
-MaintenanceWindow_StartTimeMinute <Int32>
-Tag <Hashtable>
-MaintenanceWindow_Type <MaintenanceWindowType>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonWorkSpacesThinClientConfig>

Description

Creates an environment for your thin client devices.

Parameters

-ClientConfig <AmazonWorkSpacesThinClientConfig>
Amazon.PowerShell.Cmdlets.WSTC.AmazonWorkSpacesThinClientClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.If you don't provide this value, then Amazon Web Services generates a random one for you.If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DesiredSoftwareSetId <String>
The ID of the software set to apply.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DesktopArn <String>
The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DesktopEndpoint <String>
The URL for the identity provider login (only for environments that use AppStream 2.0).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceCreationTag <Hashtable>
A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeviceCreationTags
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyArn <String>
The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaintenanceWindow_ApplyTimeOf <ApplyTimeOf>
The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaintenanceWindow_DaysOfTheWeek <String[]>
The days of the week during which the maintenance window is open.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaintenanceWindow_EndTimeHour <Int32>
The hour for the maintenance window end (00-23).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaintenanceWindow_EndTimeMinute <Int32>
The minutes for the maintenance window end (00-59).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaintenanceWindow_StartTimeHour <Int32>
The hour for the maintenance window start (00-23).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaintenanceWindow_StartTimeMinute <Int32>
The minutes past the hour for the maintenance window start (00-59).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaintenanceWindow_Type <MaintenanceWindowType>
An option to select the default or custom maintenance window.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name for the environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DesktopArn parameter. The -PassThru parameter is deprecated, use -Select '^DesktopArn' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpacesThinClient.Model.CreateEnvironmentResponse). Specifying the name of a property of type Amazon.WorkSpacesThinClient.Model.CreateEnvironmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SoftwareSetUpdateMode <SoftwareSetUpdateMode>
An option to define which software updates to apply.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SoftwareSetUpdateSchedule <SoftwareSetUpdateSchedule>
An option to define if software updates should be applied within a maintenance window.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
A map of the key-value pairs of the tag or tags to assign to the resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.WorkSpacesThinClient.Model.EnvironmentSummary or Amazon.WorkSpacesThinClient.Model.CreateEnvironmentResponse
This cmdlet returns an Amazon.WorkSpacesThinClient.Model.EnvironmentSummary object. The service call response (type Amazon.WorkSpacesThinClient.Model.CreateEnvironmentResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z