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 ModifyWorkspaceProperties API operation.

Syntax

Edit-WKSWorkspaceProperty
-WorkspaceId <String>
-WorkspaceProperties_ComputeTypeName <Compute>
-DataReplication <DataReplication>
-GlobalAccelerator_Mode <AGAModeForWorkSpaceEnum>
-WorkspaceProperties_OperatingSystemName <OperatingSystemName>
-GlobalAccelerator_PreferredProtocol <AGAPreferredProtocolForWorkSpace>
-WorkspaceProperties_Protocol <String[]>
-WorkspaceProperties_RootVolumeSizeGib <Int32>
-WorkspaceProperties_RunningMode <RunningMode>
-WorkspaceProperties_RunningModeAutoStopTimeoutInMinute <Int32>
-WorkspaceProperties_UserVolumeSizeGib <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonWorkSpacesConfig>

Description

Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace. The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

Parameters

-ClientConfig <AmazonWorkSpacesConfig>
Amazon.PowerShell.Cmdlets.WKS.AmazonWorkSpacesClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataReplication <DataReplication>
Indicates the data replication status.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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)
-GlobalAccelerator_Mode <AGAModeForWorkSpaceEnum>
Indicates if Global Accelerator for WorkSpaces is enabled, disabled, or the same mode as the associated directory.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWorkspaceProperties_GlobalAccelerator_Mode
-GlobalAccelerator_PreferredProtocol <AGAPreferredProtocolForWorkSpace>
Indicates the preferred protocol for Global Accelerator.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWorkspaceProperties_GlobalAccelerator_PreferredProtocol
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the WorkspaceId parameter. The -PassThru parameter is deprecated, use -Select '^WorkspaceId' 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 cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpaces.Model.ModifyWorkspacePropertiesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkspaceId <String>
The identifier of the WorkSpace.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-WorkspaceProperties_ComputeTypeName <Compute>
The compute type. For more information, see Amazon WorkSpaces Bundles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkspaceProperties_OperatingSystemName <OperatingSystemName>
The name of the operating system.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkspaceProperties_Protocol <String[]>
The protocol. For more information, see Protocols for Amazon WorkSpaces.
  • Only available for WorkSpaces created with PCoIP bundles.
  • The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP).
  • Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWorkspaceProperties_Protocols
-WorkspaceProperties_RootVolumeSizeGib <Int32>
The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkspaceProperties_RunningMode <RunningMode>
The running mode. For more information, see Manage the WorkSpace Running Mode.The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkspaceProperties_RunningModeAutoStopTimeoutInMinute <Int32>
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWorkspaceProperties_RunningModeAutoStopTimeoutInMinutes
-WorkspaceProperties_UserVolumeSizeGib <Int32>
The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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

None or Amazon.WorkSpaces.Model.ModifyWorkspacePropertiesResponse
This cmdlet does not generate any output.The service response (type Amazon.WorkSpaces.Model.ModifyWorkspacePropertiesResponse) be returned by specifying '-Select *'.

Examples

Example 1

Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
This Sample changes the Workspace Running Mode Property to Auto Stop for the specified Workspace
Administration Guide
Developer Guide
Service API Reference
User Guide
AWS Tools for PowerShell User Guide

Supported Version

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