AWS SDK Version 3 for .NET
API 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.

Describes a fleet.

Inheritance Hierarchy

System.Object
  Amazon.AppStream.Model.Fleet

Namespace: Amazon.AppStream.Model
Assembly: AWSSDK.AppStream.dll
Version: 3.x.y.z

Syntax

C#
public class Fleet

The Fleet type exposes the following members

Constructors

NameDescription
Public Method Fleet()

Properties

NameTypeDescription
Public Property Arn System.String

Gets and sets the property Arn.

The Amazon Resource Name (ARN) for the fleet.

Public Property ComputeCapacityStatus Amazon.AppStream.Model.ComputeCapacityStatus

Gets and sets the property ComputeCapacityStatus.

The capacity status for the fleet.

Public Property CreatedTime System.DateTime

Gets and sets the property CreatedTime.

The time the fleet was created.

Public Property Description System.String

Gets and sets the property Description.

The description to display.

Public Property DisconnectTimeoutInSeconds System.Int32

Gets and sets the property DisconnectTimeoutInSeconds.

The amount of time that a streaming session remains active after users disconnect. If they 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.

Public Property DisplayName System.String

Gets and sets the property DisplayName.

The fleet name to display.

Public Property 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.

Public Property EnableDefaultInternetAccess System.Boolean

Gets and sets the property EnableDefaultInternetAccess.

Indicates whether default internet access is enabled for the fleet.

Public Property FleetErrors System.Collections.Generic.List<Amazon.AppStream.Model.FleetError>

Gets and sets the property FleetErrors.

The fleet errors.

Public Property FleetType Amazon.AppStream.FleetType

Gets and sets the property FleetType.

The fleet type.

ALWAYS_ON

Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.

ON_DEMAND

Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

Public Property IamRoleArn System.String

Gets and sets the property IamRoleArn.

The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.

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.

Public Property 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 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.

Public Property ImageArn System.String

Gets and sets the property ImageArn.

The ARN for the public, private, or shared image.

Public Property ImageName System.String

Gets and sets the property ImageName.

The name of the image used to create the fleet.

Public Property InstanceType System.String

Gets and sets the property InstanceType.

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

Public Property 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 360000.

Public Property Name System.String

Gets and sets the property Name.

The name of the fleet.

Public Property State Amazon.AppStream.FleetState

Gets and sets the property State.

The current state for the fleet.

Public Property VpcConfig Amazon.AppStream.Model.VpcConfig

Gets and sets the property VpcConfig.

The VPC configuration for the fleet.

Version Information

.NET Standard:
Supported in: 2.0, 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms