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

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::StartGameSessionPlacementInput

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

Instance Attribute Details

#desired_player_sessions ⇒ Array<Types::DesiredPlayerSession>

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

Returns:

• (Array<Types::DesiredPlayerSession>)

# File 'lib/aws-sdk-gamelift/types.rb', line 9665

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_properties ⇒ Array<Types::GameProperty>

A set of key-value pairs that can store custom data in a game session. For example: ‘“difficulty”, “Value”: “novice”`.

Returns:

• (Array<Types::GameProperty>)

# File 'lib/aws-sdk-gamelift/types.rb', line 9665

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_data ⇒ String

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]).

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 9665

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_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 9665

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_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 9665

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_count ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-gamelift/types.rb', line 9665

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_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.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 9665

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_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.

Returns:

• (Array<Types::PlayerLatency>)

# File 'lib/aws-sdk-gamelift/types.rb', line 9665

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