AWS::AppStream::Fleet - Amazon CloudFormation
SyntaxPropertiesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::AppStream::Fleet

The AWS::AppStream::Fleet resource creates a fleet for Amazon AppStream 2.0. A fleet consists of streaming instances that run a specified image when using Always-On or On-Demand.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::AppStream::Fleet",
  "Properties" : {
      "ComputeCapacity" : ComputeCapacity,
      "Description" : String,
      "DisconnectTimeoutInSeconds" : Integer,
      "DisplayName" : String,
      "DomainJoinInfo" : DomainJoinInfo,
      "EnableDefaultInternetAccess" : Boolean,
      "FleetType" : String,
      "IamRoleArn" : String,
      "IdleDisconnectTimeoutInSeconds" : Integer,
      "ImageArn" : String,
      "ImageName" : String,
      "InstanceType" : String,
      "MaxConcurrentSessions" : Integer,
      "MaxSessionsPerInstance" : Integer,
      "MaxUserDurationInSeconds" : Integer,
      "Name" : String,
      "Platform" : String,
      "SessionScriptS3Location" : S3Location,
      "StreamView" : String,
      "Tags" : [ Tag, ... ],
      "UsbDeviceFilterStrings" : [ String, ... ],
      "VpcConfig" : VpcConfig
    }
}

Properties

ComputeCapacity

The desired capacity for the fleet. This is not allowed for Elastic fleets.

Required: No

Type: ComputeCapacity

Update requires: No interruption

Description

The description to display.

Required: No

Type: String

Maximum: 256

Update requires: No interruption

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

Required: No

Type: Integer

Update requires: No interruption

DisplayName

The fleet name to display.

Required: No

Type: String

Maximum: 100

Update requires: No interruption

DomainJoinInfo

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.

Required: No

Type: DomainJoinInfo

Update requires: No interruption

EnableDefaultInternetAccess

Enables or disables default internet access for the fleet.

Required: No

Type: Boolean

Update requires: No interruption

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.

ELASTIC

The pool of streaming instances is managed by Amazon AppStream 2.0. When a user selects their application or desktop to launch, they will start streaming after the app block has been downloaded and mounted to a streaming instance.

Allowed Values: ALWAYS_ON | ELASTIC | ON_DEMAND

Required: No

Type: String

Update requires: Replacement

IamRoleArn

The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the Amazon Security Token Service 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.

Required: No

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}$

Update requires: No interruption

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

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: No

Type: Integer

Update requires: No interruption

ImageArn

The ARN of the public, private, or shared image to use.

Required: No

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}$

Update requires: No interruption

ImageName

The name of the image used to create the fleet.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Update requires: No interruption

InstanceType

The instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:

  • stream.standard.small

  • 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.memory.z1d.large

  • stream.memory.z1d.xlarge

  • stream.memory.z1d.2xlarge

  • stream.memory.z1d.3xlarge

  • stream.memory.z1d.6xlarge

  • stream.memory.z1d.12xlarge

  • stream.graphics-design.large

  • stream.graphics-design.xlarge

  • stream.graphics-design.2xlarge

  • stream.graphics-design.4xlarge

  • stream.graphics-desktop.2xlarge

  • stream.graphics.g4dn.xlarge

  • stream.graphics.g4dn.2xlarge

  • stream.graphics.g4dn.4xlarge

  • stream.graphics.g4dn.8xlarge

  • stream.graphics.g4dn.12xlarge

  • stream.graphics.g4dn.16xlarge

  • stream.graphics-pro.4xlarge

  • stream.graphics-pro.8xlarge

  • stream.graphics-pro.16xlarge

The following instance types are available for Elastic fleets:

  • stream.standard.small

  • stream.standard.medium

Required: Yes

Type: String

Minimum: 1

Update requires: No interruption

MaxConcurrentSessions

The maximum number of concurrent sessions that can be run on an Elastic fleet. This setting is required for Elastic fleets, but is not used for other fleet types.

Required: No

Type: Integer

Update requires: No interruption

MaxSessionsPerInstance

Max number of user sessions on an instance. This is applicable only for multi-session fleets.

Required: No

Type: Integer

Update requires: No interruption

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.

Required: No

Type: Integer

Update requires: No interruption

Name

A unique name for the fleet.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Update requires: Replacement

Platform

The platform of the fleet. Platform is a required setting for Elastic fleets, and is not used for other fleet types.

Required: No

Type: String

Allowed values: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2

Update requires: No interruption

SessionScriptS3Location

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

Required: No

Type: S3Location

Update requires: No interruption

StreamView

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.

Required: No

Type: String

Allowed values: APP | DESKTOP

Update requires: No interruption

Tags

An array of key-value pairs.

Required: No

Type: Array of Tag

Update requires: No interruption

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.

Required: No

Type: Array of String

Update requires: No interruption

VpcConfig

The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types.

Required: No

Type: VpcConfig

Update requires: No interruption

See also

  • CreateFleet in the Amazon AppStream 2.0 API Reference