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

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

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

Overview

Note:

When making an API call, you may pass StartGameSessionPlacementInput data as a hash:

{
  placement_id: "IdStringModel", # required
  game_session_queue_name: "GameSessionQueueName", # required
  game_properties: [
    {
      key: "GamePropertyKey", # required
      value: "GamePropertyValue", # required
    },
  ],
  maximum_player_session_count: 1, # required
  game_session_name: "NonZeroAndMaxString",
  player_latencies: [
    {
      player_id: "NonZeroAndMaxString",
      region_identifier: "NonZeroAndMaxString",
      latency_in_milliseconds: 1.0,
    },
  ],
  desired_player_sessions: [
    {
      player_id: "NonZeroAndMaxString",
      player_data: "PlayerData",
    },
  ],
  game_session_data: "GameSessionData",
}

Represents the input for a request action.

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:



5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5610

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)
  include Aws::Structure
end

#game_propertiesArray<Types::GameProperty>

Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

Returns:



5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5610

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)
  include Aws::Structure
end

#game_session_dataString

Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

Returns:

  • (String)


5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5610

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)
  include Aws::Structure
end

#game_session_nameString

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

Returns:

  • (String)


5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5610

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)
  include Aws::Structure
end

#game_session_queue_nameString

Name of the queue to use to place the new game session.

Returns:

  • (String)


5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5610

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)
  include Aws::Structure
end

#maximum_player_session_countInteger

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

Returns:

  • (Integer)


5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5610

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)
  include Aws::Structure
end

#placement_idString

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 unless you are resubmitting a canceled or timed-out placement request.

Returns:

  • (String)


5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5610

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)
  include Aws::Structure
end

#player_latenciesArray<Types::PlayerLatency>

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS 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:



5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5610

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)
  include Aws::Structure
end