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)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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.



1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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 displayed to end users.

Returns:

  • (String)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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 displayed to end users.

Returns:

  • (String)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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 for streaming instances to join a domain.



1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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:



1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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

Returns:

  • (String)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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 image used by the fleet.

Returns:

  • (String)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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:



1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1126

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