AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartGameSessionPlacementInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  placement_id: "IdStringModel", # required
  game_session_queue_name: "GameSessionQueueNameOrArn", # 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:

#game_propertiesArray<Types::GameProperty>

Set of custom properties for a game session, formatted as key:value pairs. These properties are 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:

  • (Array<Types::GameProperty>)

    Set of custom properties for a game session, formatted as key:value pairs.

#game_session_dataString

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)

    Set of custom game session properties, formatted as a single string value.

#game_session_nameString

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

Returns:

  • (String)

    A descriptive label that is associated with a game session.

#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)

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

#maximum_player_session_countInteger

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

Returns:

  • (Integer)

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

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

Returns:

  • (String)

    A unique identifier to assign to the new game session placement.

#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:

  • (Array<Types::PlayerLatency>)

    Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS Regions.