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)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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 information for the fleet.



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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 at which the fleet was created.

Returns:

  • (Time)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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 on the AppStream 2.0 portal.

Returns:

  • (String)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600.

Returns:

  • (Integer)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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 name displayed to end users on the AppStream 2.0 portal.

Returns:

  • (String)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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 DirectoryName and OrganizationalUnitDistinguishedName values, which are used to join domains for the AppStream 2.0 streaming instances.



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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

Whether default internet access is enabled for the fleet.

Returns:

  • (Boolean)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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 list of fleet errors is appended to this list.

Returns:



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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 of compute resources for the fleet. The fleet instances are launched from this instance type.

Returns:

  • (String)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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 for which a streaming session can run. The value can be any numeric value in seconds between 600 and 57600.

Returns:

  • (Integer)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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:



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 913

class Fleet < Struct.new(
  :arn,
  :name,
  :display_name,
  :description,
  :image_name,
  :instance_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