AppStream 2.0 Fleet

AppStream 2.0 Fleet is a group of streaming instances in AWS AppStream 2.0 that deliver virtualized applications or desktops to users. A fleet defines the instance type, capacity, scaling policies, and network settings used to stream applications. It provides the compute resources that run the applications, and can be configured for on-demand or always-on availability depending on performance and cost requirements.

aws.appstream_fleet

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
arncorestringThe Amazon Resource Name (ARN) for the fleet.
compute_capacity_statuscorejsonThe capacity status for the fleet.
created_timecoretimestampThe time the fleet was created.
descriptioncorestringThe description to display.
disconnect_timeout_in_secondscoreint64The 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.
domain_join_infocorejsonThe name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
enable_default_internet_accesscoreboolIndicates whether default internet access is enabled for the fleet.
fleet_errorscorejsonThe fleet errors.
fleet_typecorestringThe 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.
iam_role_arncorestringThe 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.
idle_disconnect_timeout_in_secondscoreint64The 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. 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.
image_arncorestringThe ARN for the public, private, or shared image.
image_namecorestringThe name of the image used to create the fleet.
instance_typecorestringThe instance type to use when launching fleet instances. The following instance types are available: 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
max_concurrent_sessionscoreint64The maximum number of concurrent sessions for the fleet.
max_sessions_per_instancecoreint64The maximum number of user sessions on an instance. This only applies to multi-session fleets.
max_user_duration_in_secondscoreint64The 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.
namecorestringThe name of the fleet.
platformcorestringThe platform of the fleet.
session_script_s3_locationcorejsonThe S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
statecorestringThe current state for the fleet.
stream_viewcorestringThe 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.
tagscorehstore
usb_device_filter_stringscorearray<string>The USB device filter strings associated with the fleet.
vpc_configcorejsonThe VPC configuration for the fleet.