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 AppStream UpdateStack API operation.

Syntax

Update-APSStack
-Name <String>
-AccessEndpoint <AccessEndpoint[]>
-AttributesToDelete <String[]>
-Description <String>
-DisplayName <String>
-EmbedHostDomain <String[]>
-ApplicationSettings_Enabled <Boolean>
-FeedbackURL <String>
-StreamingExperienceSettings_PreferredProtocol <PreferredProtocol>
-RedirectURL <String>
-ApplicationSettings_SettingsGroup <String>
-StorageConnector <StorageConnector[]>
-UserSetting <UserSetting[]>
-DeleteStorageConnector <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonAppStreamConfig>

Description

Updates the specified fields for the specified stack.

Parameters

-AccessEndpoint <AccessEndpoint[]>
The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccessEndpoints
-ApplicationSettings_Enabled <Boolean>
Enables or disables persistent application settings for users during their streaming sessions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ApplicationSettings_SettingsGroup <String>
The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AttributesToDelete <String[]>
The stack attributes to delete.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonAppStreamConfig>
Amazon.PowerShell.Cmdlets.APS.AmazonAppStreamClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeleteStorageConnector <Boolean>
Deletes the storage connectors currently enabled for the stack.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeleteStorageConnectors
-Description <String>
The description to display.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisplayName <String>
The stack name to display.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EmbedHostDomain <String[]>
The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEmbedHostDomains
-FeedbackURL <String>
The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
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)
-Name <String>
The name of the stack.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RedirectURL <String>
The URL that users are redirected to after their streaming session ends.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Stack'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.UpdateStackResponse). Specifying the name of a property of type Amazon.AppStream.Model.UpdateStackResponse 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)
-StorageConnector <StorageConnector[]>
The storage connectors to enable.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConnectors
-StreamingExperienceSettings_PreferredProtocol <PreferredProtocol>
The preferred protocol that you want to use while streaming your application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserSetting <UserSetting[]>
The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUserSettings

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.AppStream.Model.Stack or Amazon.AppStream.Model.UpdateStackResponse
This cmdlet returns an Amazon.AppStream.Model.Stack object. The service call response (type Amazon.AppStream.Model.UpdateStackResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

Update-APSStack -Name PowershellStack -ApplicationSettings_Enabled $True -ApplicationSettings_SettingsGroup PowershellStack -StorageConnector @{ConnectorType="HOMEFOLDERS"}                                                                              
AccessEndpoints     : {}
ApplicationSettings : Amazon.AppStream.Model.ApplicationSettingsResponse
Arn                 : arn:aws:appstream:us-east-1:123456789012:stack/PowershellStack
CreatedTime         : 4/24/2019 8:49:29 AM
Description         : PowershellStack
DisplayName         : PowershellStack
EmbedHostDomains    : {}
FeedbackURL         :
Name                : PowershellStack
RedirectURL         :
StackErrors         : {}
StorageConnectors   : {Amazon.AppStream.Model.StorageConnector, Amazon.AppStream.Model.StorageConnector}
UserSettings        : {Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting}
This sample updates(enables) Application settings persistence and Home Folders on a Stack
AWS Tools for PowerShell User Guide

Supported Version

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