Class: Aws::GameLift::Types::StartGameSessionPlacementInput

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#desired_player_sessionsArray<Types::DesiredPlayerSession>

Set of information on each player to create a player session for.

Returns:



8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 8195

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)
  SENSITIVE = []
  include Aws::Structure
end

#game_propertiesArray<Types::GameProperty>

A set of key-value pairs that can store custom data in a game session. For example: \{"Key": "difficulty", "Value": "novice"\}.

Returns:



8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 8195

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)
  SENSITIVE = []
  include Aws::Structure
end

#game_session_dataString

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Returns:

  • (String)


8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 8195

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)
  SENSITIVE = []
  include Aws::Structure
end

#game_session_nameString

A descriptive label that is associated with a game session. Session names do not need to be unique.

Returns:

  • (String)


8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 8195

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)
  SENSITIVE = []
  include Aws::Structure
end

#game_session_queue_nameString

Name of the queue to use to place the new game session. You can use either the queue name or ARN value.

Returns:

  • (String)


8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 8195

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)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_player_session_countInteger

The maximum number of players that can be connected simultaneously to the game session.

Returns:

  • (Integer)


8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 8195

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)
  SENSITIVE = []
  include Aws::Structure
end

#placement_idString

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.

Returns:

  • (String)


8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 8195

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)
  SENSITIVE = []
  include Aws::Structure
end

#player_latenciesArray<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.

Returns:



8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 8195

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)
  SENSITIVE = []
  include Aws::Structure
end