Menu
Amazon AppStream 2.0
API Reference (API Version 2016-12-01)

Fleet

Contains the parameters for a fleet.

Contents

Arn

The ARN for the fleet.

Type: String

Pattern: ^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$

Required: Yes

ComputeCapacityStatus

The capacity status for the fleet.

Type: ComputeCapacityStatus object

Required: Yes

CreatedTime

The time the fleet was created.

Type: Timestamp

Required: No

Description

The description for display.

Type: String

Length Constraints: Minimum length of 1.

Required: No

DisconnectTimeoutInSeconds

The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

Type: Integer

Required: No

DisplayName

The fleet name for display.

Type: String

Length Constraints: Minimum length of 1.

Required: No

DomainJoinInfo

The information needed to join a Microsoft Active Directory domain.

Type: DomainJoinInfo object

Required: No

EnableDefaultInternetAccess

Indicates whether default internet access is enabled for the fleet.

Type: Boolean

Required: No

FleetErrors

The fleet errors.

Type: Array of FleetError objects

Required: No

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.

Type: String

Valid Values: ALWAYS_ON | ON_DEMAND

Required: No

ImageName

The name of the image used to create the fleet.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

InstanceType

The instance type to use when launching fleet instances.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

MaxUserDurationInSeconds

The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

Type: Integer

Required: No

Name

The name of the fleet.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

State

The current state for the fleet.

Type: String

Valid Values: STARTING | RUNNING | STOPPING | STOPPED

Required: Yes

VpcConfig

The VPC configuration for the fleet.

Type: VpcConfig object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: