Class: Aws::GameLift::Types::GameSession

Inherits:

Struct

Object
Struct
Aws::GameLift::Types::GameSession

show all

Includes:: Structure

Defined in:: lib/aws-sdk-gamelift/types.rb

Overview

Properties describing a game session.

A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED.

Amazon GameLift Servers retains a game session resource for 30 days after the game session ends. You can reuse idempotency token values after this time. Game session logs are retained for 14 days.

All APIs by task][1: [1]: docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets

Constant Summary collapse

SENSITIVE =

[:ip_address, :port]

Instance Attribute Summary collapse

#creation_time ⇒ Time

A time stamp indicating when this data object was created.
#creator_id ⇒ String

A unique identifier for a player.
#current_player_session_count ⇒ Integer

Number of players currently in the game session.
#dns_name ⇒ String

The DNS identifier assigned to the instance that is running the game session.
#fleet_arn ⇒ String

The Amazon Resource Name ([ARN]) associated with the GameLift fleet that this game session is running on.
#fleet_id ⇒ String

A unique identifier for the fleet that the game session is running on.
#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_id ⇒ String

A unique identifier for the game session.
#ip_address ⇒ String

The IP address of the game session.
#location ⇒ String

The fleet location where the game session is running.
#matchmaker_data ⇒ String

Information about the matchmaking process that resulted in the game session, if matchmaking was used.
#maximum_player_session_count ⇒ Integer

The maximum number of players that can be connected simultaneously to the game session.
#name ⇒ String

A descriptive label that is associated with a game session.
#player_session_creation_policy ⇒ String

Indicates whether the game session is accepting new players.
#port ⇒ Integer

The port number for the game session.
#status ⇒ String

Current status of the game session.
#status_reason ⇒ String

Provides additional information about game session status.
#termination_time ⇒ Time

A time stamp indicating when this data object was terminated.

Instance Attribute Details

#creation_time ⇒ `Time`

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example ‘“1469498468.057”`).

Returns:

(Time)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#creator_id ⇒ `String`

A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

Returns:

(String)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#current_player_session_count ⇒ `Integer`

Number of players currently in the game session.

Returns:

(Integer)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#fleet_arn ⇒ `String`

The Amazon Resource Name ([ARN]) associated with the GameLift fleet that this game session is running on.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html

Returns:

(String)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#fleet_id ⇒ `String`

A unique identifier for the fleet that the game session is running on.

Returns:

(String)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  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”`.

<note markdown=“1”> Avoid using periods (“.”) in property keys if you plan to search for game sessions by properties. Property keys containing periods cannot be searched and will be filtered out from search results due to search index limitations.

</note>

Returns:

(Array<Types::GameProperty>)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  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 with a request to start a new game session. For more information, 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 6752

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#game_session_id ⇒ `String`

A unique identifier for the game session. A game session ARN has the following format: ‘arn:aws:gamelift:<location>::gamesession/<fleet ID>/<custom ID string or idempotency token>`.

Returns:

(String)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#ip_address ⇒ `String`

The IP address of the game session. To connect to a Amazon GameLift Servers game server, an app needs both the IP address and port number.

Returns:

(String)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#location ⇒ `String`

The fleet location where the game session is running. This value might specify the fleet’s home Region or a remote location. Location is expressed as an Amazon Web Services Region code such as us-west-2.

Returns:

(String)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#matchmaker_data ⇒ `String`

Information about the matchmaking process that resulted in the game session, if matchmaking was used. Data is in JSON syntax, formatted as a string. Information includes the matchmaker ID as well as player attributes and team assignments. For more details on matchmaker data, see [Match Data]. Matchmaker data is updated whenever new players are added during a successful backfill (see [StartMatchBackfill]).

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

Returns:

(String)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  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 6752

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#player_session_creation_policy ⇒ `String`

Indicates whether the game session is accepting new players.

Returns:

(String)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#port ⇒ `Integer`

The port number for the game session. To connect to a Amazon GameLift Servers game server, an app needs both the IP address and port number.

Returns:

(Integer)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#status ⇒ `String`

Current status of the game session. A game session must have an ACTIVE status to have player sessions.

Returns:

(String)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#status_reason ⇒ `String`

Provides additional information about game session status.

INTERRUPTED – The game session was hosted on an EC2 Spot instance that was reclaimed, causing the active game session to be stopped.
TRIGGERED_ON_PROCESS_TERMINATE – The game session was stopped by calling TerminateGameSession with the termination mode TRIGGER_ON_PROCESS_TERMINATE.
FORCE_TERMINATED – The game session was stopped by calling TerminateGameSession with the termination mode FORCE_TERMINATE.

Returns:

(String)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

#termination_time ⇒ `Time`

A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example ‘“1469498468.057”`).

Returns:

(Time)

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

class GameSession < Struct.new(
  :game_session_id,
  :name,
  :fleet_id,
  :fleet_arn,
  :creation_time,
  :termination_time,
  :current_player_session_count,
  :maximum_player_session_count,
  :status,
  :status_reason,
  :game_properties,
  :ip_address,
  :dns_name,
  :port,
  :player_session_creation_policy,
  :creator_id,
  :game_session_data,
  :matchmaker_data,
  :location)
  SENSITIVE = [:ip_address, :port]
  include Aws::Structure
end

Class: Aws::GameLift::Types::GameSession

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time ⇒ Time

#creator_id ⇒ String

#current_player_session_count ⇒ Integer

#dns_name ⇒ String

#fleet_arn ⇒ String

#fleet_id ⇒ String

#game_properties ⇒ Array<Types::GameProperty>

#game_session_data ⇒ String

#game_session_id ⇒ String

#ip_address ⇒ String

#location ⇒ String

#matchmaker_data ⇒ String

#maximum_player_session_count ⇒ Integer

#name ⇒ String

#player_session_creation_policy ⇒ String

#port ⇒ Integer

#status ⇒ String

#status_reason ⇒ String

#termination_time ⇒ Time

#creation_time ⇒ `Time`

#creator_id ⇒ `String`

#current_player_session_count ⇒ `Integer`

#dns_name ⇒ `String`

#fleet_arn ⇒ `String`

#fleet_id ⇒ `String`

#game_properties ⇒ `Array<Types::GameProperty>`

#game_session_data ⇒ `String`

#game_session_id ⇒ `String`

#ip_address ⇒ `String`

#location ⇒ `String`

#matchmaker_data ⇒ `String`

#maximum_player_session_count ⇒ `Integer`

#name ⇒ `String`

#player_session_creation_policy ⇒ `String`

#port ⇒ `Integer`

#status ⇒ `String`

#status_reason ⇒ `String`

#termination_time ⇒ `Time`