class Aws::GameLift::Types::GameSession

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

Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.

**Related actions**

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | [All APIs by task]

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

@!attribute [rw] game_session_id

A unique identifier for the game session. A game session ARN has the
following format: `arn:aws:gamelift:<region>::gamesession/<fleet
ID>/<custom ID string or idempotency token>`.
@return [String]

@!attribute [rw] name

A descriptive label that is associated with a game session. Session
names do not need to be unique.
@return [String]

@!attribute [rw] fleet_id

A unique identifier for the fleet that the game session is running
on.
@return [String]

@!attribute [rw] fleet_arn

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

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

@!attribute [rw] creation_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"`).
@return [Time]

@!attribute [rw] termination_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"`).
@return [Time]

@!attribute [rw] current_player_session_count

Number of players currently in the game session.
@return [Integer]

@!attribute [rw] maximum_player_session_count

The maximum number of players that can be connected simultaneously
to the game session.
@return [Integer]

@!attribute [rw] status

Current status of the game session. A game session must have an
`ACTIVE` status to have player sessions.
@return [String]

@!attribute [rw] status_reason

Provides additional information about game session status.
`INTERRUPTED` indicates that the game session was hosted on a spot
instance that was reclaimed, causing the active game session to be
terminated.
@return [String]

@!attribute [rw] game_properties

A 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. You can search for active game sessions based on this
custom data with SearchGameSessions.
@return [Array<Types::GameProperty>]

@!attribute [rw] ip_address

The IP address of the game session. To connect to a GameLift game
server, an app needs both the IP address and port number.
@return [String]

@!attribute [rw] dns_name

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

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]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses
@return [String]

@!attribute [rw] port

The port number for the game session. To connect to a GameLift game
server, an app needs both the IP address and port number.
@return [Integer]

@!attribute [rw] player_session_creation_policy

Indicates whether or not the game session is accepting new players.
@return [String]

@!attribute [rw] creator_id

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.
@return [String]

@!attribute [rw] game_session_data

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.
@return [String]

@!attribute [rw] matchmaker_data

Information about the matchmaking process that was used to create
the game session. It is in JSON syntax, formatted as a string. In
addition the matchmaking configuration used, it 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]. Matchmaker data is useful when requesting match backfills,
and is updated whenever new players are added during a successful
backfill (see StartMatchBackfill).

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

@!attribute [rw] location

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 AWS Region code such as `us-west-2`.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GameSession AWS API Documentation

Constants

SENSITIVE