GameSession

public struct GameSession : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let creationTime: TimeStamp?

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

    Declaration

    Swift

    public let creatorId: String?

  • Number of players currently in the game session.

    Declaration

    Swift

    public let currentPlayerSessionCount: Int?

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

    Declaration

    Swift

    public let dnsName: String?

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

    Declaration

    Swift

    public let fleetArn: String?

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

    Declaration

    Swift

    public let fleetId: String?

  • 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 (see Start a Game Session). You can search for active game sessions based on this custom data with SearchGameSessions.

    Declaration

    Swift

    public let gameProperties: [GameProperty]?

  • 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).

    Declaration

    Swift

    public let gameSessionData: String?

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

    Declaration

    Swift

    public let gameSessionId: String?

  • IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number.

    Declaration

    Swift

    public let ipAddress: String?

  • 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. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).

    Declaration

    Swift

    public let matchmakerData: String?

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

    Declaration

    Swift

    public let maximumPlayerSessionCount: Int?

  • A descriptive label that is associated with a game session. Session names do not need to be unique.

    Declaration

    Swift

    public let name: String?

  • Indicates whether or not the game session is accepting new players.

    Declaration

    Swift

    public let playerSessionCreationPolicy: PlayerSessionCreationPolicy?

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

    Declaration

    Swift

    public let port: Int?

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

    Declaration

    Swift

    public let status: GameSessionStatus?

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

    Declaration

    Swift

    public let statusReason: GameSessionStatusReason?

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

    Declaration

    Swift

    public let terminationTime: TimeStamp?

  • Undocumented

    Declaration

    Swift

    public init(creationTime: TimeStamp? = nil, creatorId: String? = nil, currentPlayerSessionCount: Int? = nil, dnsName: String? = nil, fleetArn: String? = nil, fleetId: String? = nil, gameProperties: [GameProperty]? = nil, gameSessionData: String? = nil, gameSessionId: String? = nil, ipAddress: String? = nil, matchmakerData: String? = nil, maximumPlayerSessionCount: Int? = nil, name: String? = nil, playerSessionCreationPolicy: PlayerSessionCreationPolicy? = nil, port: Int? = nil, status: GameSessionStatus? = nil, statusReason: GameSessionStatusReason? = nil, terminationTime: TimeStamp? = nil)