AWS SDK for C++  1.9.4
AWS SDK for C++
Public Member Functions | List of all members
Aws::GameLift::Model::PlayerSession Class Reference

#include <PlayerSession.h>

Public Member Functions

 PlayerSession ()
 
 PlayerSession (Aws::Utils::Json::JsonView jsonValue)
 
PlayerSessionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetPlayerSessionId () const
 
bool PlayerSessionIdHasBeenSet () const
 
void SetPlayerSessionId (const Aws::String &value)
 
void SetPlayerSessionId (Aws::String &&value)
 
void SetPlayerSessionId (const char *value)
 
PlayerSessionWithPlayerSessionId (const Aws::String &value)
 
PlayerSessionWithPlayerSessionId (Aws::String &&value)
 
PlayerSessionWithPlayerSessionId (const char *value)
 
const Aws::StringGetPlayerId () const
 
bool PlayerIdHasBeenSet () const
 
void SetPlayerId (const Aws::String &value)
 
void SetPlayerId (Aws::String &&value)
 
void SetPlayerId (const char *value)
 
PlayerSessionWithPlayerId (const Aws::String &value)
 
PlayerSessionWithPlayerId (Aws::String &&value)
 
PlayerSessionWithPlayerId (const char *value)
 
const Aws::StringGetGameSessionId () const
 
bool GameSessionIdHasBeenSet () const
 
void SetGameSessionId (const Aws::String &value)
 
void SetGameSessionId (Aws::String &&value)
 
void SetGameSessionId (const char *value)
 
PlayerSessionWithGameSessionId (const Aws::String &value)
 
PlayerSessionWithGameSessionId (Aws::String &&value)
 
PlayerSessionWithGameSessionId (const char *value)
 
const Aws::StringGetFleetId () const
 
bool FleetIdHasBeenSet () const
 
void SetFleetId (const Aws::String &value)
 
void SetFleetId (Aws::String &&value)
 
void SetFleetId (const char *value)
 
PlayerSessionWithFleetId (const Aws::String &value)
 
PlayerSessionWithFleetId (Aws::String &&value)
 
PlayerSessionWithFleetId (const char *value)
 
const Aws::StringGetFleetArn () const
 
bool FleetArnHasBeenSet () const
 
void SetFleetArn (const Aws::String &value)
 
void SetFleetArn (Aws::String &&value)
 
void SetFleetArn (const char *value)
 
PlayerSessionWithFleetArn (const Aws::String &value)
 
PlayerSessionWithFleetArn (Aws::String &&value)
 
PlayerSessionWithFleetArn (const char *value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
PlayerSessionWithCreationTime (const Aws::Utils::DateTime &value)
 
PlayerSessionWithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetTerminationTime () const
 
bool TerminationTimeHasBeenSet () const
 
void SetTerminationTime (const Aws::Utils::DateTime &value)
 
void SetTerminationTime (Aws::Utils::DateTime &&value)
 
PlayerSessionWithTerminationTime (const Aws::Utils::DateTime &value)
 
PlayerSessionWithTerminationTime (Aws::Utils::DateTime &&value)
 
const PlayerSessionStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const PlayerSessionStatus &value)
 
void SetStatus (PlayerSessionStatus &&value)
 
PlayerSessionWithStatus (const PlayerSessionStatus &value)
 
PlayerSessionWithStatus (PlayerSessionStatus &&value)
 
const Aws::StringGetIpAddress () const
 
bool IpAddressHasBeenSet () const
 
void SetIpAddress (const Aws::String &value)
 
void SetIpAddress (Aws::String &&value)
 
void SetIpAddress (const char *value)
 
PlayerSessionWithIpAddress (const Aws::String &value)
 
PlayerSessionWithIpAddress (Aws::String &&value)
 
PlayerSessionWithIpAddress (const char *value)
 
const Aws::StringGetDnsName () const
 
bool DnsNameHasBeenSet () const
 
void SetDnsName (const Aws::String &value)
 
void SetDnsName (Aws::String &&value)
 
void SetDnsName (const char *value)
 
PlayerSessionWithDnsName (const Aws::String &value)
 
PlayerSessionWithDnsName (Aws::String &&value)
 
PlayerSessionWithDnsName (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
PlayerSessionWithPort (int value)
 
const Aws::StringGetPlayerData () const
 
bool PlayerDataHasBeenSet () const
 
void SetPlayerData (const Aws::String &value)
 
void SetPlayerData (Aws::String &&value)
 
void SetPlayerData (const char *value)
 
PlayerSessionWithPlayerData (const Aws::String &value)
 
PlayerSessionWithPlayerData (Aws::String &&value)
 
PlayerSessionWithPlayerData (const char *value)
 

Detailed Description

Represents a player session. Player sessions are created either for a specific game session, or as part of a game session placement or matchmaking request. A player session can represents a reserved player slot in a game session (when status is RESERVED) or actual player activity in a game session (when status is ACTIVE). A player session object, including player data, is automatically passed to a game session when the player connects to the game session and is validated. After the game session ends, player sessions information is retained for 30 days and then removed.

Related actions

CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task

See Also:

AWS API Reference

Definition at line 45 of file PlayerSession.h.

Constructor & Destructor Documentation

◆ PlayerSession() [1/2]

Aws::GameLift::Model::PlayerSession::PlayerSession ( )

◆ PlayerSession() [2/2]

Aws::GameLift::Model::PlayerSession::PlayerSession ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CreationTimeHasBeenSet()

bool Aws::GameLift::Model::PlayerSession::CreationTimeHasBeenSet ( ) const
inline

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

Definition at line 319 of file PlayerSession.h.

◆ DnsNameHasBeenSet()

bool Aws::GameLift::Model::PlayerSession::DnsNameHasBeenSet ( ) const
inline

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.

Definition at line 547 of file PlayerSession.h.

◆ FleetArnHasBeenSet()

bool Aws::GameLift::Model::PlayerSession::FleetArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

Definition at line 256 of file PlayerSession.h.

◆ FleetIdHasBeenSet()

bool Aws::GameLift::Model::PlayerSession::FleetIdHasBeenSet ( ) const
inline

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

Definition at line 203 of file PlayerSession.h.

◆ GameSessionIdHasBeenSet()

bool Aws::GameLift::Model::PlayerSession::GameSessionIdHasBeenSet ( ) const
inline

A unique identifier for the game session that the player session is connected to.

Definition at line 154 of file PlayerSession.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::GameLift::Model::PlayerSession::GetCreationTime ( ) const
inline

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

Definition at line 312 of file PlayerSession.h.

◆ GetDnsName()

const Aws::String& Aws::GameLift::Model::PlayerSession::GetDnsName ( ) const
inline

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.

Definition at line 533 of file PlayerSession.h.

◆ GetFleetArn()

const Aws::String& Aws::GameLift::Model::PlayerSession::GetFleetArn ( ) const
inline

The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

Definition at line 248 of file PlayerSession.h.

◆ GetFleetId()

const Aws::String& Aws::GameLift::Model::PlayerSession::GetFleetId ( ) const
inline

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

Definition at line 197 of file PlayerSession.h.

◆ GetGameSessionId()

const Aws::String& Aws::GameLift::Model::PlayerSession::GetGameSessionId ( ) const
inline

A unique identifier for the game session that the player session is connected to.

Definition at line 148 of file PlayerSession.h.

◆ GetIpAddress()

const Aws::String& Aws::GameLift::Model::PlayerSession::GetIpAddress ( ) const
inline

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

Definition at line 476 of file PlayerSession.h.

◆ GetPlayerData()

const Aws::String& Aws::GameLift::Model::PlayerSession::GetPlayerData ( ) const
inline

Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

Definition at line 663 of file PlayerSession.h.

◆ GetPlayerId()

const Aws::String& Aws::GameLift::Model::PlayerSession::GetPlayerId ( ) const
inline

A unique identifier for a player that is associated with this player session.

Definition at line 99 of file PlayerSession.h.

◆ GetPlayerSessionId()

const Aws::String& Aws::GameLift::Model::PlayerSession::GetPlayerSessionId ( ) const
inline

A unique identifier for a player session.

Definition at line 57 of file PlayerSession.h.

◆ GetPort()

int Aws::GameLift::Model::PlayerSession::GetPort ( ) const
inline

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

Definition at line 638 of file PlayerSession.h.

◆ GetStatus()

const PlayerSessionStatus& Aws::GameLift::Model::PlayerSession::GetStatus ( ) const
inline

Current status of the player session.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Definition at line 404 of file PlayerSession.h.

◆ GetTerminationTime()

const Aws::Utils::DateTime& Aws::GameLift::Model::PlayerSession::GetTerminationTime ( ) const
inline

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

Definition at line 355 of file PlayerSession.h.

◆ IpAddressHasBeenSet()

bool Aws::GameLift::Model::PlayerSession::IpAddressHasBeenSet ( ) const
inline

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

Definition at line 482 of file PlayerSession.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::GameLift::Model::PlayerSession::Jsonize ( ) const

◆ operator=()

PlayerSession& Aws::GameLift::Model::PlayerSession::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PlayerDataHasBeenSet()

bool Aws::GameLift::Model::PlayerSession::PlayerDataHasBeenSet ( ) const
inline

Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

Definition at line 669 of file PlayerSession.h.

◆ PlayerIdHasBeenSet()

bool Aws::GameLift::Model::PlayerSession::PlayerIdHasBeenSet ( ) const
inline

A unique identifier for a player that is associated with this player session.

Definition at line 105 of file PlayerSession.h.

◆ PlayerSessionIdHasBeenSet()

bool Aws::GameLift::Model::PlayerSession::PlayerSessionIdHasBeenSet ( ) const
inline

A unique identifier for a player session.

Definition at line 62 of file PlayerSession.h.

◆ PortHasBeenSet()

bool Aws::GameLift::Model::PlayerSession::PortHasBeenSet ( ) const
inline

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

Definition at line 644 of file PlayerSession.h.

◆ SetCreationTime() [1/2]

void Aws::GameLift::Model::PlayerSession::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 333 of file PlayerSession.h.

◆ SetCreationTime() [2/2]

void Aws::GameLift::Model::PlayerSession::SetCreationTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 326 of file PlayerSession.h.

◆ SetDnsName() [1/3]

void Aws::GameLift::Model::PlayerSession::SetDnsName ( Aws::String &&  value)
inline

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.

Definition at line 575 of file PlayerSession.h.

◆ SetDnsName() [2/3]

void Aws::GameLift::Model::PlayerSession::SetDnsName ( const Aws::String value)
inline

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.

Definition at line 561 of file PlayerSession.h.

◆ SetDnsName() [3/3]

void Aws::GameLift::Model::PlayerSession::SetDnsName ( const char *  value)
inline

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.

Definition at line 589 of file PlayerSession.h.

◆ SetFleetArn() [1/3]

void Aws::GameLift::Model::PlayerSession::SetFleetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

Definition at line 272 of file PlayerSession.h.

◆ SetFleetArn() [2/3]

void Aws::GameLift::Model::PlayerSession::SetFleetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

Definition at line 264 of file PlayerSession.h.

◆ SetFleetArn() [3/3]

void Aws::GameLift::Model::PlayerSession::SetFleetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

Definition at line 280 of file PlayerSession.h.

◆ SetFleetId() [1/3]

void Aws::GameLift::Model::PlayerSession::SetFleetId ( Aws::String &&  value)
inline

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

Definition at line 215 of file PlayerSession.h.

◆ SetFleetId() [2/3]

void Aws::GameLift::Model::PlayerSession::SetFleetId ( const Aws::String value)
inline

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

Definition at line 209 of file PlayerSession.h.

◆ SetFleetId() [3/3]

void Aws::GameLift::Model::PlayerSession::SetFleetId ( const char *  value)
inline

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

Definition at line 221 of file PlayerSession.h.

◆ SetGameSessionId() [1/3]

void Aws::GameLift::Model::PlayerSession::SetGameSessionId ( Aws::String &&  value)
inline

A unique identifier for the game session that the player session is connected to.

Definition at line 166 of file PlayerSession.h.

◆ SetGameSessionId() [2/3]

void Aws::GameLift::Model::PlayerSession::SetGameSessionId ( const Aws::String value)
inline

A unique identifier for the game session that the player session is connected to.

Definition at line 160 of file PlayerSession.h.

◆ SetGameSessionId() [3/3]

void Aws::GameLift::Model::PlayerSession::SetGameSessionId ( const char *  value)
inline

A unique identifier for the game session that the player session is connected to.

Definition at line 172 of file PlayerSession.h.

◆ SetIpAddress() [1/3]

void Aws::GameLift::Model::PlayerSession::SetIpAddress ( Aws::String &&  value)
inline

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

Definition at line 494 of file PlayerSession.h.

◆ SetIpAddress() [2/3]

void Aws::GameLift::Model::PlayerSession::SetIpAddress ( const Aws::String value)
inline

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

Definition at line 488 of file PlayerSession.h.

◆ SetIpAddress() [3/3]

void Aws::GameLift::Model::PlayerSession::SetIpAddress ( const char *  value)
inline

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

Definition at line 500 of file PlayerSession.h.

◆ SetPlayerData() [1/3]

void Aws::GameLift::Model::PlayerSession::SetPlayerData ( Aws::String &&  value)
inline

Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

Definition at line 681 of file PlayerSession.h.

◆ SetPlayerData() [2/3]

void Aws::GameLift::Model::PlayerSession::SetPlayerData ( const Aws::String value)
inline

Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

Definition at line 675 of file PlayerSession.h.

◆ SetPlayerData() [3/3]

void Aws::GameLift::Model::PlayerSession::SetPlayerData ( const char *  value)
inline

Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

Definition at line 687 of file PlayerSession.h.

◆ SetPlayerId() [1/3]

void Aws::GameLift::Model::PlayerSession::SetPlayerId ( Aws::String &&  value)
inline

A unique identifier for a player that is associated with this player session.

Definition at line 117 of file PlayerSession.h.

◆ SetPlayerId() [2/3]

void Aws::GameLift::Model::PlayerSession::SetPlayerId ( const Aws::String value)
inline

A unique identifier for a player that is associated with this player session.

Definition at line 111 of file PlayerSession.h.

◆ SetPlayerId() [3/3]

void Aws::GameLift::Model::PlayerSession::SetPlayerId ( const char *  value)
inline

A unique identifier for a player that is associated with this player session.

Definition at line 123 of file PlayerSession.h.

◆ SetPlayerSessionId() [1/3]

void Aws::GameLift::Model::PlayerSession::SetPlayerSessionId ( Aws::String &&  value)
inline

A unique identifier for a player session.

Definition at line 72 of file PlayerSession.h.

◆ SetPlayerSessionId() [2/3]

void Aws::GameLift::Model::PlayerSession::SetPlayerSessionId ( const Aws::String value)
inline

A unique identifier for a player session.

Definition at line 67 of file PlayerSession.h.

◆ SetPlayerSessionId() [3/3]

void Aws::GameLift::Model::PlayerSession::SetPlayerSessionId ( const char *  value)
inline

A unique identifier for a player session.

Definition at line 77 of file PlayerSession.h.

◆ SetPort()

void Aws::GameLift::Model::PlayerSession::SetPort ( int  value)
inline

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

Definition at line 650 of file PlayerSession.h.

◆ SetStatus() [1/2]

void Aws::GameLift::Model::PlayerSession::SetStatus ( const PlayerSessionStatus value)
inline

Current status of the player session.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Definition at line 430 of file PlayerSession.h.

◆ SetStatus() [2/2]

void Aws::GameLift::Model::PlayerSession::SetStatus ( PlayerSessionStatus &&  value)
inline

Current status of the player session.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Definition at line 443 of file PlayerSession.h.

◆ SetTerminationTime() [1/2]

void Aws::GameLift::Model::PlayerSession::SetTerminationTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 376 of file PlayerSession.h.

◆ SetTerminationTime() [2/2]

void Aws::GameLift::Model::PlayerSession::SetTerminationTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 369 of file PlayerSession.h.

◆ StatusHasBeenSet()

bool Aws::GameLift::Model::PlayerSession::StatusHasBeenSet ( ) const
inline

Current status of the player session.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Definition at line 417 of file PlayerSession.h.

◆ TerminationTimeHasBeenSet()

bool Aws::GameLift::Model::PlayerSession::TerminationTimeHasBeenSet ( ) const
inline

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

Definition at line 362 of file PlayerSession.h.

◆ WithCreationTime() [1/2]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 347 of file PlayerSession.h.

◆ WithCreationTime() [2/2]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithCreationTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 340 of file PlayerSession.h.

◆ WithDnsName() [1/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithDnsName ( Aws::String &&  value)
inline

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.

Definition at line 617 of file PlayerSession.h.

◆ WithDnsName() [2/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithDnsName ( const Aws::String value)
inline

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.

Definition at line 603 of file PlayerSession.h.

◆ WithDnsName() [3/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithDnsName ( const char *  value)
inline

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.

Definition at line 631 of file PlayerSession.h.

◆ WithFleetArn() [1/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithFleetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

Definition at line 296 of file PlayerSession.h.

◆ WithFleetArn() [2/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithFleetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

Definition at line 288 of file PlayerSession.h.

◆ WithFleetArn() [3/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithFleetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

Definition at line 304 of file PlayerSession.h.

◆ WithFleetId() [1/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithFleetId ( Aws::String &&  value)
inline

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

Definition at line 233 of file PlayerSession.h.

◆ WithFleetId() [2/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithFleetId ( const Aws::String value)
inline

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

Definition at line 227 of file PlayerSession.h.

◆ WithFleetId() [3/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithFleetId ( const char *  value)
inline

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

Definition at line 239 of file PlayerSession.h.

◆ WithGameSessionId() [1/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithGameSessionId ( Aws::String &&  value)
inline

A unique identifier for the game session that the player session is connected to.

Definition at line 184 of file PlayerSession.h.

◆ WithGameSessionId() [2/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithGameSessionId ( const Aws::String value)
inline

A unique identifier for the game session that the player session is connected to.

Definition at line 178 of file PlayerSession.h.

◆ WithGameSessionId() [3/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithGameSessionId ( const char *  value)
inline

A unique identifier for the game session that the player session is connected to.

Definition at line 190 of file PlayerSession.h.

◆ WithIpAddress() [1/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithIpAddress ( Aws::String &&  value)
inline

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

Definition at line 512 of file PlayerSession.h.

◆ WithIpAddress() [2/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithIpAddress ( const Aws::String value)
inline

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

Definition at line 506 of file PlayerSession.h.

◆ WithIpAddress() [3/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithIpAddress ( const char *  value)
inline

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

Definition at line 518 of file PlayerSession.h.

◆ WithPlayerData() [1/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithPlayerData ( Aws::String &&  value)
inline

Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

Definition at line 699 of file PlayerSession.h.

◆ WithPlayerData() [2/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithPlayerData ( const Aws::String value)
inline

Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

Definition at line 693 of file PlayerSession.h.

◆ WithPlayerData() [3/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithPlayerData ( const char *  value)
inline

Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

Definition at line 705 of file PlayerSession.h.

◆ WithPlayerId() [1/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithPlayerId ( Aws::String &&  value)
inline

A unique identifier for a player that is associated with this player session.

Definition at line 135 of file PlayerSession.h.

◆ WithPlayerId() [2/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithPlayerId ( const Aws::String value)
inline

A unique identifier for a player that is associated with this player session.

Definition at line 129 of file PlayerSession.h.

◆ WithPlayerId() [3/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithPlayerId ( const char *  value)
inline

A unique identifier for a player that is associated with this player session.

Definition at line 141 of file PlayerSession.h.

◆ WithPlayerSessionId() [1/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithPlayerSessionId ( Aws::String &&  value)
inline

A unique identifier for a player session.

Definition at line 87 of file PlayerSession.h.

◆ WithPlayerSessionId() [2/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithPlayerSessionId ( const Aws::String value)
inline

A unique identifier for a player session.

Definition at line 82 of file PlayerSession.h.

◆ WithPlayerSessionId() [3/3]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithPlayerSessionId ( const char *  value)
inline

A unique identifier for a player session.

Definition at line 92 of file PlayerSession.h.

◆ WithPort()

PlayerSession& Aws::GameLift::Model::PlayerSession::WithPort ( int  value)
inline

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

Definition at line 656 of file PlayerSession.h.

◆ WithStatus() [1/2]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithStatus ( const PlayerSessionStatus value)
inline

Current status of the player session.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Definition at line 456 of file PlayerSession.h.

◆ WithStatus() [2/2]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithStatus ( PlayerSessionStatus &&  value)
inline

Current status of the player session.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Definition at line 469 of file PlayerSession.h.

◆ WithTerminationTime() [1/2]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithTerminationTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 390 of file PlayerSession.h.

◆ WithTerminationTime() [2/2]

PlayerSession& Aws::GameLift::Model::PlayerSession::WithTerminationTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 383 of file PlayerSession.h.


The documentation for this class was generated from the following file: