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.
Container for the parameters to the UpdateFleet operation. 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 following based on
the fleet type:
Always-On and On-Demand fleet types
You can update the DisplayName
, ComputeCapacity
, ImageARN
, ImageName
,
IdleDisconnectTimeoutInSeconds
, and DisconnectTimeoutInSeconds
attributes.
Elastic fleet type
You can update the DisplayName
, IdleDisconnectTimeoutInSeconds
, DisconnectTimeoutInSeconds
,
MaxConcurrentSessions
, SessionScriptS3Location
and UsbDeviceFilterStrings
attributes.
If the fleet is in the STARTING
or STOPPED
state, you can't update it.
Namespace: Amazon.AppStream.Model
Assembly: AWSSDK.AppStream.dll
Version: 3.x.y.z
public class UpdateFleetRequest : AmazonAppStreamRequest IAmazonWebServiceRequest
The UpdateFleetRequest type exposes the following members
Name | Description | |
---|---|---|
UpdateFleetRequest() |
Name | Type | Description | |
---|---|---|---|
AttributesToDelete | System.Collections.Generic.List<System.String> |
Gets and sets the property AttributesToDelete. The fleet attributes to delete. |
|
ComputeCapacity | Amazon.AppStream.Model.ComputeCapacity |
Gets and sets the property ComputeCapacity. The desired capacity for the fleet. This is not allowed for Elastic fleets. |
|
DeleteVpcConfig | System.Boolean |
Gets and sets the property DeleteVpcConfig. Deletes the VPC association for the specified fleet. |
|
Description | System.String |
Gets and sets the property Description. The description to display. |
|
DisconnectTimeoutInSeconds | System.Int32 |
Gets and sets the property DisconnectTimeoutInSeconds. 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. |
|
DisplayName | System.String |
Gets and sets the property DisplayName. The fleet name to display. |
|
DomainJoinInfo | Amazon.AppStream.Model.DomainJoinInfo |
Gets and sets the property DomainJoinInfo. The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. |
|
EnableDefaultInternetAccess | System.Boolean |
Gets and sets the property EnableDefaultInternetAccess. Enables or disables default internet access for the fleet. |
|
IamRoleArn | System.String |
Gets and sets the property IamRoleArn.
The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a
role, a fleet instance calls the AWS Security Token Service (STS) For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide. |
|
IdleDisconnectTimeoutInSeconds | System.Int32 |
Gets and sets the property IdleDisconnectTimeoutInSeconds.
The amount of time that users can be idle (inactive) before they are disconnected
from their streaming session and the 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. |
|
ImageArn | System.String |
Gets and sets the property ImageArn. The ARN of the public, private, or shared image to use. |
|
ImageName | System.String |
Gets and sets the property ImageName. The name of the image used to create the fleet. |
|
InstanceType | System.String |
Gets and sets the property InstanceType. The instance type to use when launching fleet instances. The following instance types are available:
The following instance types are available for Elastic fleets:
|
|
MaxConcurrentSessions | System.Int32 |
Gets and sets the property MaxConcurrentSessions. The maximum number of concurrent sessions for a fleet. |
|
MaxSessionsPerInstance | System.Int32 |
Gets and sets the property MaxSessionsPerInstance. The maximum number of user sessions on an instance. This only applies to multi-session fleets. |
|
MaxUserDurationInSeconds | System.Int32 |
Gets and sets the property MaxUserDurationInSeconds. 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 432000. |
|
Name | System.String |
Gets and sets the property Name. A unique name for the fleet. |
|
Platform | Amazon.AppStream.PlatformType |
Gets and sets the property Platform. The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets. |
|
SessionScriptS3Location | Amazon.AppStream.Model.S3Location |
Gets and sets the property SessionScriptS3Location. The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets. |
|
StreamView | Amazon.AppStream.StreamView |
Gets and sets the property StreamView.
The AppStream 2.0 view that is displayed to your users when they stream from the fleet.
When
The default value is |
|
UsbDeviceFilterStrings | System.Collections.Generic.List<System.String> |
Gets and sets the property UsbDeviceFilterStrings. The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets. |
|
VpcConfig | Amazon.AppStream.Model.VpcConfig |
Gets and sets the property VpcConfig. The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5