aws_appstream_fleet

account_id

Type: STRING

arn

Type: STRING
Provider name: Arn
Description: The Amazon Resource Name (ARN) for the fleet.

compute_capacity_status

Type: STRUCT
Provider name: ComputeCapacityStatus
Description: The capacity status for the fleet.

• active_user_sessions
  Type: INT32
  Provider name: ActiveUserSessions
  Description: The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.
  
• actual_user_sessions
  Type: INT32
  Provider name: ActualUserSessions
  Description: The total number of session slots that are available for streaming or are currently streaming. ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions This only applies to multi-session fleets.
  
• available
  Type: INT32
  Provider name: Available
  Description: The number of currently available instances that can be used to stream sessions.
  
• available_user_sessions
  Type: INT32
  Provider name: AvailableUserSessions
  Description: The number of idle session slots currently available for user sessions. AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions This only applies to multi-session fleets.
  
• desired
  Type: INT32
  Provider name: Desired
  Description: The desired number of streaming instances.
  
• desired_user_sessions
  Type: INT32
  Provider name: DesiredUserSessions
  Description: The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state. DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity This only applies to multi-session fleets.
  
• in_use
  Type: INT32
  Provider name: InUse
  Description: The number of instances in use for streaming.
  
• running
  Type: INT32
  Provider name: Running
  Description: The total number of simultaneous streaming instances that are running.
  

created_time

Type: TIMESTAMP
Provider name: CreatedTime
Description: The time the fleet was created.

description

Type: STRING
Provider name: Description
Description: The description to display.

disconnect_timeout_in_seconds

Type: INT32
Provider name: DisconnectTimeoutInSeconds
Description: 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.

domain_join_info

Type: STRUCT
Provider name: DomainJoinInfo
Description: The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

• directory_name
  Type: STRING
  Provider name: DirectoryName
  Description: The fully qualified name of the directory (for example, corp.example.com).
  
• organizational_unit_distinguished_name
  Type: STRING
  Provider name: OrganizationalUnitDistinguishedName
  Description: The distinguished name of the organizational unit for computer accounts.
  

enable_default_internet_access

Type: BOOLEAN
Provider name: EnableDefaultInternetAccess
Description: Indicates whether default internet access is enabled for the fleet.

fleet_errors

Type: UNORDERED_LIST_STRUCT
Provider name: FleetErrors
Description: The fleet errors.

• error_code
  Type: STRING
  Provider name: ErrorCode
  Description: The error code.
  
• error_message
  Type: STRING
  Provider name: ErrorMessage
  Description: The error message.
  

fleet_type

Type: STRING
Provider name: FleetType
Description: 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.

iam_role_arn

Type: STRING
Provider name: IamRoleArn
Description: 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.

idle_disconnect_timeout_in_seconds

Type: INT32
Provider name: IdleDisconnectTimeoutInSeconds
Description: 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. 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_arn

Type: STRING
Provider name: ImageArn
Description: The ARN for the public, private, or shared image.

image_name

Type: STRING
Provider name: ImageName
Description: The name of the image used to create the fleet.

instance_type

Type: STRING
Provider name: InstanceType
Description: The 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_sessions

Type: INT32
Provider name: MaxConcurrentSessions
Description: The maximum number of concurrent sessions for the fleet.

max_sessions_per_instance

Type: INT32
Provider name: MaxSessionsPerInstance
Description: The maximum number of user sessions on an instance. This only applies to multi-session fleets.

max_user_duration_in_seconds

Type: INT32
Provider name: MaxUserDurationInSeconds
Description: 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.

name

Type: STRING
Provider name: Name
Description: The name of the fleet.

platform

Type: STRING
Provider name: Platform
Description: The platform of the fleet.

session_script_s3_location

Type: STRUCT
Provider name: SessionScriptS3Location
Description: The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

• s3_bucket
  Type: STRING
  Provider name: S3Bucket
  Description: The S3 bucket of the S3 object.
  
• s3_key
  Type: STRING
  Provider name: S3Key
  Description: The S3 key of the S3 object. This is required when used for the following:
  • IconS3Location (Actions: CreateApplication and UpdateApplication)
  • SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)
  • ScriptDetails (Actions: CreateAppBlock)
  • SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)
  • SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)

state

Type: STRING
Provider name: State
Description: The current state for the fleet.

stream_view

Type: STRING
Provider name: StreamView
Description: 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.

tags

Type: UNORDERED_LIST_STRING

usb_device_filter_strings

Type: UNORDERED_LIST_STRING
Provider name: UsbDeviceFilterStrings
Description: The USB device filter strings associated with the fleet.

vpc_config

Type: STRUCT
Provider name: VpcConfig
Description: The VPC configuration for the fleet.

• security_group_ids
  Type: UNORDERED_LIST_STRING
  Provider name: SecurityGroupIds
  Description: The identifiers of the security groups for the fleet or image builder.
  
• subnet_ids
  Type: UNORDERED_LIST_STRING
  Provider name: SubnetIds
  Description: The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.