Class: Aws::GameLift::Types::GameSessionPlacement

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::GameSessionPlacement

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

Represents a potential game session placement, including the full details of the original placement request and the current status.

<note markdown=“1”> If the game session placement status is ‘PENDING`, the properties for game session ID/ARN, region, IP address/DNS, and port aren’t final. A game session is not active and ready to accept players until placement status reaches ‘FULFILLED`. When the placement is in `PENDING` status, Amazon GameLift may attempt to place a game session multiple times before succeeding. With each attempt it creates a GameSession object and updates this placement object with the new game session properties..

</note>

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:ip_address, :port]

Instance Attribute Summary

• #dns_name ⇒ String

  The DNS identifier assigned to the instance that is running the game session.

• #end_time ⇒ Time

  Time stamp indicating when this request was completed, canceled, or timed out.

• #game_properties ⇒ Array<Types::GameProperty>

  A set of key-value pairs that can store custom data in a game session.

• #game_session_arn ⇒ String

  Identifier for the game session created by this placement request.

• #game_session_data ⇒ String

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

• #game_session_id ⇒ String

  A unique identifier for the game session.

• #game_session_name ⇒ String

  A descriptive label that is associated with a game session.

• #game_session_queue_name ⇒ String

  A descriptive label that is associated with game session queue.

• #game_session_region ⇒ String

  Name of the Region where the game session created by this placement request is running.

• #ip_address ⇒ String

  The IP address of the game session.

• #matchmaker_data ⇒ String

  Information on the matchmaking process for this game.

• #maximum_player_session_count ⇒ Integer

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

• #placed_player_sessions ⇒ Array<Types::PlacedPlayerSession>

  A collection of information on player sessions created in response to the game session placement request.

• #placement_id ⇒ String

  A unique identifier for a 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.

• #port ⇒ Integer

  The port number for the game session.

• #start_time ⇒ Time

  Time stamp indicating when this request was placed in the queue.

• #status ⇒ String

  Current status of the game session placement request.

Instance Attribute Details

#dns_name ⇒ String

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

• TLS-enabled fleets: ‘<unique identifier>.<region identifier>.amazongamelift.com`.

• Non-TLS-enabled fleets: ‘ec2-<unique identifier>.compute.amazonaws.com`. (See [Amazon EC2 Instance IP Addressing].)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses

Returns:

• (String)

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

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#end_time ⇒ Time

Time stamp indicating when this request was completed, canceled, or timed out.

Returns:

• (Time)

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

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  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 6446

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#game_session_arn ⇒ String

Identifier for the game session created by this placement request. This identifier is unique across all Regions. This value isn’t final until placement status is ‘FULFILLED`.

Returns:

• (String)

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

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  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 6446

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#game_session_id ⇒ String

A unique identifier for the game session. This value isn’t final until placement status is ‘FULFILLED`.

Returns:

• (String)

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

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  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 6446

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#game_session_queue_name ⇒ String

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

Returns:

• (String)

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

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#game_session_region ⇒ String

Name of the Region where the game session created by this placement request is running. This value isn’t final until placement status is ‘FULFILLED`.

Returns:

• (String)

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

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#ip_address ⇒ String

The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value isn’t final until placement status is ‘FULFILLED`.

Returns:

• (String)

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

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#matchmaker_data ⇒ String

Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see [Match Data].

[1]: docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data

Returns:

• (String)

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

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  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 6446

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#placed_player_sessions ⇒ Array<Types::PlacedPlayerSession>

A collection of information on player sessions created in response to the game session placement request. These player sessions are created only after a new game session is successfully placed (placement status is ‘FULFILLED`). This information includes the player ID, provided in the placement request, and a corresponding player session ID.

Returns:

• (Array<Types::PlacedPlayerSession>)

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

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#placement_id ⇒ String

A unique identifier for a game session placement.

Returns:

• (String)

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

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  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.

Returns:

• (Array<Types::PlayerLatency>)

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

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#port ⇒ Integer

The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value isn’t final until placement status is ‘FULFILLED`.

Returns:

• (Integer)

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

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#start_time ⇒ Time

Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example ‘“1469498468.057”`).

Returns:

• (Time)

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

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#status ⇒ String

Current status of the game session placement request.

• PENDING – The placement request is in the queue waiting to be processed. Game session properties are not yet final.

• FULFILLED – A new game session has been successfully placed. Game session properties are now final.

• CANCELLED – The placement request was canceled.

• TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

• FAILED – Amazon GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

Returns:

• (String)

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

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :dns_name,
  :port,
  :placed_player_sessions,
  :game_session_data,
  :matchmaker_data)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end