AWS CloudFormation
User Guide (Version )

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.

Syntax

To declare this entity in your AWS 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, "ImageArn" : String, "ImageName" : String, "InstanceType" : String, "MaxUserDurationInSeconds" : Integer, "Name" : String, "Tags" : [ Tag, ... ], "VpcConfig" : VpcConfig } }

YAML

Type: AWS::AppStream::Fleet Properties: ComputeCapacity: ComputeCapacity Description: String DisconnectTimeoutInSeconds: Integer DisplayName: String DomainJoinInfo: DomainJoinInfo EnableDefaultInternetAccess: Boolean FleetType: String ImageArn: String ImageName: String InstanceType: String MaxUserDurationInSeconds: Integer Name: String Tags: - Tag VpcConfig: VpcConfig

Properties

ComputeCapacity

The desired capacity for the fleet.

Required: Yes

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

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.

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.

Required: No

Type: String

Allowed Values: ALWAYS_ON | ON_DEMAND

Update requires: Replacement

ImageArn

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

Required: No

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

Update requires: No interruption

ImageName

The name of the image used to create the fleet.

Required: No

Type: String

Minimum: 1

Update requires: No interruption

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

Required: Yes

Type: String

Minimum: 1

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

Required: No

Type: Integer

Update requires: No interruption

Name

A unique name for the fleet.

Required: No

Type: String

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

Update requires: Replacement

Tags

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Required: No

Type: List of Tag

Update requires: No interruption

VpcConfig

The VPC configuration for the fleet.

Required: No

Type: VpcConfig

Update requires: No interruption

See Also

  • CreateFleet in the Amazon AppStream 2.0 API Reference

On this page: