Skip to content

GameSessionConnectionInfo

Source code in docs_src/capo_gamelift/types/game_session_connection_info.py
class GameSessionConnectionInfo(TypedDict, closed=True):
    game_session_arn: NotRequired["capo_gamelift.types.arn_string_model.ArnStringModel"]
    """<p>An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: For Home Region game session - <code>arn:aws:gamelift:<home_region>::gamesession/<fleet ID>/<ID string></code>. For Remote Location game session - <code>arn:aws:gamelift:<home_region>::gamesession/<fleet ID>/<location>/<ID string></code>.</p>"""
    ip_address: NotRequired["capo_gamelift.types.ip_address.IpAddress"]
    """<p>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.</p>"""
    dns_name: NotRequired["capo_gamelift.types.dns_name.DnsName"]
    """<p>The DNS identifier assigned to the instance that is running the game session. Values have the following format:</p> <ul> <li> <p>TLS-enabled fleets: <code><unique identifier>.<region identifier>.amazongamelift.com</code>.</p> </li> <li> <p>Non-TLS-enabled fleets: <code>ec2-<unique identifier>.compute.amazonaws.com</code>. (See <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses">Amazon EC2 Instance IP Addressing</a>.)</p> </li> </ul> <p>When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.</p>"""
    port: NotRequired["capo_gamelift.types.positive_integer.PositiveInteger"]
    """<p>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.</p>"""
    matched_player_sessions: NotRequired[
        "capo_gamelift.types.matched_player_session_list.MatchedPlayerSessionList"
    ]
    """<p>A collection of player session IDs, one for each player ID that was included in the original matchmaking request. </p>"""
    player_gateway_status: NotRequired[
        "capo_gamelift.types.player_gateway_status.PlayerGatewayStatus"
    ]
    """<p>The current status of player gateway for the game session. Note, even if a fleet has PlayerGatewayMode configured as <code>ENABLED</code>, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see <a href="https://docs.aws.amazon.com/gameliftservers/latest/developerguide/gamelift-regions.html">supported locations</a>.</p> <p>Possible values include:</p> <ul> <li> <p> <code>ENABLED</code> -- Player gateway is available for this game session.</p> </li> <li> <p> <code>DISABLED</code> -- Player gateway is not available for this game session.</p> </li> </ul>"""

dns_name instance-attribute

dns_name: NotRequired[DnsName]

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

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

game_session_arn instance-attribute

game_session_arn: NotRequired[ArnStringModel]

An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:::gamesession//. For Remote Location game session - arn:aws:gamelift:::gamesession///.

ip_address instance-attribute

ip_address: NotRequired[IpAddress]

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.

matched_player_sessions instance-attribute

matched_player_sessions: NotRequired[MatchedPlayerSessionList]

A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

player_gateway_status instance-attribute

player_gateway_status: NotRequired[PlayerGatewayStatus]

The current status of player gateway for the game session. Note, even if a fleet has PlayerGatewayMode configured as ENABLED, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see supported locations.

Possible values include:

  • ENABLED -- Player gateway is available for this game session.

  • DISABLED -- Player gateway is not available for this game session.

port instance-attribute

port: NotRequired[PositiveInteger]

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.