Fleet

The Amazon Resource Name (ARN) for the fleet.

Type: String

Pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[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

The capacity status for the fleet.

Type: ComputeCapacityStatus object

Required: Yes

The instance type to use when launching fleet instances. The following instance types are available:

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

The name of the fleet.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

The current state for the fleet.

Type: String

Valid Values: STARTING | RUNNING | STOPPING | STOPPED

Required: Yes

The time the fleet was created.

Type: Timestamp

Required: No

The description to display.

Type: String

Length Constraints: Minimum length of 1.

Required: No

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 36000.

Type: Integer

Required: No

The fleet name to display.

Type: String

Length Constraints: Minimum length of 1.

Required: No

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

Type: DomainJoinInfo object

Required: No

Indicates whether default internet access is enabled for the fleet.

Type: Boolean

Required: No

The fleet errors.

Type: Array of FleetError objects

Required: No

The fleet type.

Type: String

Valid Values: ALWAYS_ON | ON_DEMAND | ELASTIC

Required: No

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.

Type: String

Pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[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: No

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 36000. The default value is 0.

Type: Integer

Required: No

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

Type: String

Pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[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: No

The name of the image used to create the fleet.

Type: String

Length Constraints: Minimum length of 1.

Required: No

The maximum number of concurrent sessions for the fleet.

Type: Integer

Required: No

The maximum number of user sessions on an instance. This only applies to multi-session fleets.

Type: Integer

Required: No

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.

Type: Integer

Required: No

The platform of the fleet.

Type: String

Valid Values: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2 | RHEL8

Required: No

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

Type: S3Location object

Required: No

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP.

Type: String

Valid Values: APP | DESKTOP

Required: No

The USB device filter strings associated with the fleet.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 100.

Pattern: ^((\w*)\s*(\w*)\s*\,\s*(\w*)\s*\,\s*\*?(\w*)\s*\,\s*\*?(\w*)\s*\,\s*\*?\d*\s*\,\s*\*?\d*\s*\,\s*[0-1]\s*\,\s*[0-1]\s*)$

Required: No

The VPC configuration for the fleet.

Type: VpcConfig object

Required: No