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. For more information, see CreateFleet in the Amazon AppStream 2.0 API Reference.

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,
    "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
  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

Update requires: No interruption

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.

Required: No

Type: Integer

Update requires: No interruption

DisplayName

The fleet name to display.

Required: No

Type: String

Update requires: No interruption

DomainJoinInfo

The information needed to join 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.

Required: No

Type: String

Update requires: Replacement

ImageArn

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

Required: No

Type: String

Update requires: No interruption

ImageName

The name of the image used to create the fleet.

Required: No

Type: String

Update requires: No interruption

InstanceType

The instance type to use when launching fleet instances.

Required: Yes

Type: String

Update requires: No interruption

MaxUserDurationInSeconds

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

Required: No

Type: Integer

Update requires: No interruption

Name

A unique name for the fleet.

Required: Yes

Type: String

Update requires: Replacement

VpcConfig

The VPC configuration for the fleet.

Required: No

Type: VpcConfig

Update requires: No interruption

AWS::AppStream::Fleet

Syntax

JSON

YAML

Properties

See Also