You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AppStream::Types::Fleet

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb

Overview

Contains the parameters for a fleet.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN for the fleet.

Returns:

  • (String)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#compute_capacity_statusTypes::ComputeCapacityStatus

The capacity status for the fleet.



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#created_timeTime

The time the fleet was created.

Returns:

  • (Time)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#descriptionString

The description for display.

Returns:

  • (String)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#disconnect_timeout_in_secondsInteger

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.

Returns:

  • (Integer)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#display_nameString

The fleet name for display.

Returns:

  • (String)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#domain_join_infoTypes::DomainJoinInfo

The information needed to join a Microsoft Active Directory domain.



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#enable_default_internet_accessBoolean

Indicates whether default internet access is enabled for the fleet.

Returns:

  • (Boolean)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#fleet_errorsArray<Types::FleetError>

The fleet errors.

Returns:



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#fleet_typeString

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.

Returns:

  • (String)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#image_nameString

The name of the image used to create the fleet.

Returns:

  • (String)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#instance_typeString

The instance type to use when launching fleet instances.

Returns:

  • (String)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#max_user_duration_in_secondsInteger

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

Returns:

  • (Integer)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#nameString

The name of the fleet.

Returns:

  • (String)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#stateString

The current state for the fleet.

Returns:

  • (String)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#vpc_configTypes::VpcConfig

The VPC configuration for the fleet.

Returns:



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1190

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity_status,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :state,
  :vpc_config,
  :created_time,
  :fleet_errors,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end