Class: Aws::GameLift::Types::StartGameSessionPlacementInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::StartGameSessionPlacementInput
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-gamelift/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#desired_player_sessions ⇒ Array<Types::DesiredPlayerSession>
Set of information on each player to create a player session for.
-
#game_properties ⇒ Array<Types::GameProperty>
A set of key-value pairs that can store custom data in a game session.
-
#game_session_data ⇒ String
A set of custom game session properties, formatted as a single string value.
-
#game_session_name ⇒ String
A descriptive label that is associated with a game session.
-
#game_session_queue_name ⇒ String
Name of the queue to use to place the new game session.
-
#maximum_player_session_count ⇒ Integer
The maximum number of players that can be connected simultaneously to the game session.
-
#placement_id ⇒ String
A unique identifier to assign to the new game session placement.
-
#player_latencies ⇒ Array<Types::PlayerLatency>
A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.
-
#priority_configuration_override ⇒ Types::PriorityConfigurationOverride
A prioritized list of locations to use for the game session placement and instructions on how to use it.
Instance Attribute Details
#desired_player_sessions ⇒ Array<Types::DesiredPlayerSession>
Set of information on each player to create a player session for.
10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 |
# File 'lib/aws-sdk-gamelift/types.rb', line 10477 class StartGameSessionPlacementInput < Struct.new( :placement_id, :game_session_queue_name, :game_properties, :maximum_player_session_count, :game_session_name, :player_latencies, :desired_player_sessions, :game_session_data, :priority_configuration_override) SENSITIVE = [] include Aws::Structure end |
#game_properties ⇒ Array<Types::GameProperty>
A set of key-value pairs that can store custom data in a game session. For example: ‘“difficulty”, “Value”: “novice”`.
10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 |
# File 'lib/aws-sdk-gamelift/types.rb', line 10477 class StartGameSessionPlacementInput < Struct.new( :placement_id, :game_session_queue_name, :game_properties, :maximum_player_session_count, :game_session_name, :player_latencies, :desired_player_sessions, :game_session_data, :priority_configuration_override) SENSITIVE = [] include Aws::Structure end |
#game_session_data ⇒ String
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. For more information, see [Start a game session].
10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 |
# File 'lib/aws-sdk-gamelift/types.rb', line 10477 class StartGameSessionPlacementInput < Struct.new( :placement_id, :game_session_queue_name, :game_properties, :maximum_player_session_count, :game_session_name, :player_latencies, :desired_player_sessions, :game_session_data, :priority_configuration_override) SENSITIVE = [] include Aws::Structure end |
#game_session_name ⇒ String
A descriptive label that is associated with a game session. Session names do not need to be unique.
10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 |
# File 'lib/aws-sdk-gamelift/types.rb', line 10477 class StartGameSessionPlacementInput < Struct.new( :placement_id, :game_session_queue_name, :game_properties, :maximum_player_session_count, :game_session_name, :player_latencies, :desired_player_sessions, :game_session_data, :priority_configuration_override) SENSITIVE = [] include Aws::Structure end |
#game_session_queue_name ⇒ String
Name of the queue to use to place the new game session. You can use either the queue name or ARN value.
10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 |
# File 'lib/aws-sdk-gamelift/types.rb', line 10477 class StartGameSessionPlacementInput < Struct.new( :placement_id, :game_session_queue_name, :game_properties, :maximum_player_session_count, :game_session_name, :player_latencies, :desired_player_sessions, :game_session_data, :priority_configuration_override) SENSITIVE = [] include Aws::Structure end |
#maximum_player_session_count ⇒ Integer
The maximum number of players that can be connected simultaneously to the game session.
10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 |
# File 'lib/aws-sdk-gamelift/types.rb', line 10477 class StartGameSessionPlacementInput < Struct.new( :placement_id, :game_session_queue_name, :game_properties, :maximum_player_session_count, :game_session_name, :player_latencies, :desired_player_sessions, :game_session_data, :priority_configuration_override) SENSITIVE = [] include Aws::Structure end |
#placement_id ⇒ String
A unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all Regions and cannot be reused.
10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 |
# File 'lib/aws-sdk-gamelift/types.rb', line 10477 class StartGameSessionPlacementInput < Struct.new( :placement_id, :game_session_queue_name, :game_properties, :maximum_player_session_count, :game_session_name, :player_latencies, :desired_player_sessions, :game_session_data, :priority_configuration_override) SENSITIVE = [] include Aws::Structure end |
#player_latencies ⇒ Array<Types::PlayerLatency>
A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.
10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 |
# File 'lib/aws-sdk-gamelift/types.rb', line 10477 class StartGameSessionPlacementInput < Struct.new( :placement_id, :game_session_queue_name, :game_properties, :maximum_player_session_count, :game_session_name, :player_latencies, :desired_player_sessions, :game_session_data, :priority_configuration_override) SENSITIVE = [] include Aws::Structure end |
#priority_configuration_override ⇒ Types::PriorityConfigurationOverride
A prioritized list of locations to use for the game session placement and instructions on how to use it. This list overrides a queue’s prioritized location list for this game session placement request only. You can include Amazon Web Services Regions, local zones, and custom locations (for Anywhere fleets). Choose a fallback strategy to instruct Amazon GameLift to use the override list for the first placement attempt only or for all placement attempts.
10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 |
# File 'lib/aws-sdk-gamelift/types.rb', line 10477 class StartGameSessionPlacementInput < Struct.new( :placement_id, :game_session_queue_name, :game_properties, :maximum_player_session_count, :game_session_name, :player_latencies, :desired_player_sessions, :game_session_data, :priority_configuration_override) SENSITIVE = [] include Aws::Structure end |