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

Syntax

Update-APSFleet
-Name <String>
-AttributesToDelete <String[]>
-Description <String>
-ComputeCapacity_DesiredInstance <Int32>
-DomainJoinInfo_DirectoryName <String>
-DisconnectTimeoutInSecond <Int32>
-DisplayName <String>
-EnableDefaultInternetAccess <Boolean>
-IdleDisconnectTimeoutInSecond <Int32>
-ImageArn <String>
-ImageName <String>
-InstanceType <String>
-MaxUserDurationInSecond <Int32>
-DomainJoinInfo_OrganizationalUnitDistinguishedName <String>
-VpcConfig_SecurityGroupId <String[]>
-VpcConfig_SubnetId <String[]>
-DeleteVpcConfig <Boolean>
-Force <SwitchParameter>

Description

Updates the specified fleet. If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the DisplayName, ComputeCapacity, ImageARN, ImageName, and DisconnectTimeoutInSeconds attributes. If the fleet is in the STARTING or STOPPING state, you can't update it.

Parameters

-AttributesToDelete <String[]>
The fleet attributes to delete.
Required?False
Position?Named
Accept pipeline input?False
-ComputeCapacity_DesiredInstance <Int32>
The desired number of streaming instances.
Required?False
Position?Named
Accept pipeline input?False
AliasesComputeCapacity_DesiredInstances
-DeleteVpcConfig <Boolean>
Deletes the VPC association for the specified fleet.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?False
-Description <String>
The description to display.
Required?False
Position?Named
Accept pipeline input?False
-DisconnectTimeoutInSecond <Int32>
The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. Specify a value between 60 and 360000.
Required?False
Position?Named
Accept pipeline input?False
AliasesDisconnectTimeoutInSeconds
-DisplayName <String>
The fleet name to display.
Required?False
Position?Named
Accept pipeline input?False
-DomainJoinInfo_DirectoryName <String>
The fully qualified name of the directory (for example, corp.example.com).
Required?False
Position?Named
Accept pipeline input?False
-DomainJoinInfo_OrganizationalUnitDistinguishedName <String>
The distinguished name of the organizational unit for computer accounts.
Required?False
Position?Named
Accept pipeline input?False
-EnableDefaultInternetAccess <Boolean>
Enables or disables default internet access for the fleet.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-IdleDisconnectTimeoutInSecond <Int32>
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
Required?False
Position?Named
Accept pipeline input?False
AliasesIdleDisconnectTimeoutInSeconds
-ImageArn <String>
The ARN of the public, private, or shared image to use.
Required?False
Position?Named
Accept pipeline input?False
-ImageName <String>
The name of the image used to create the fleet.
Required?False
Position?Named
Accept pipeline input?False
-InstanceType <String>
The instance type to use when launching fleet instances. The following instance types are available:
  • stream.standard.medium
  • stream.standard.large
  • stream.compute.large
  • stream.compute.xlarge
  • stream.compute.2xlarge
  • stream.compute.4xlarge
  • stream.compute.8xlarge
  • stream.memory.large
  • stream.memory.xlarge
  • stream.memory.2xlarge
  • stream.memory.4xlarge
  • stream.memory.8xlarge
  • stream.graphics-design.large
  • stream.graphics-design.xlarge
  • stream.graphics-design.2xlarge
  • stream.graphics-design.4xlarge
  • stream.graphics-desktop.2xlarge
  • stream.graphics-pro.4xlarge
  • stream.graphics-pro.8xlarge
  • stream.graphics-pro.16xlarge
Required?False
Position?Named
Accept pipeline input?False
-MaxUserDurationInSecond <Int32>
The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.Specify a value between 600 and 360000.
Required?False
Position?Named
Accept pipeline input?False
AliasesMaxUserDurationInSeconds
-Name <String>
A unique name for the fleet.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-VpcConfig_SecurityGroupId <String[]>
The identifiers of the security groups for the fleet or image builder.
Required?False
Position?Named
Accept pipeline input?False
AliasesVpcConfig_SecurityGroupIds
-VpcConfig_SubnetId <String[]>
The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.
Required?False
Position?Named
Accept pipeline input?False
AliasesVpcConfig_SubnetIds

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

You can pipe a String object to this cmdlet for the Name parameter.

Outputs

This cmdlet returns a Amazon.AppStream.Model.Fleet object. The service call response (type Amazon.AppStream.Model.UpdateFleetResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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