GameServer

public struct GameServer : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.

    Declaration

    Swift

    public let claimStatus: GameServerClaimStatus?

  • The port and IP address that must be used to establish a client connection to the game server.

    Declaration

    Swift

    public let connectionInfo: String?

  • A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

    Declaration

    Swift

    public let gameServerData: String?

  • The ARN identifier for the game server group where the game server is located.

    Declaration

    Swift

    public let gameServerGroupArn: String?

  • A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

    Declaration

    Swift

    public let gameServerGroupName: String?

  • A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.

    Declaration

    Swift

    public let gameServerId: String?

  • The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

    Declaration

    Swift

    public let instanceId: String?

  • Timestamp that indicates the last time the game server was claimed with a ClaimGameServer request. The format is a number expressed in Unix time as milliseconds (for example “1469498468.057”). This value is used to calculate when a claimed game server’s status should revert to null.

    Declaration

    Swift

    public let lastClaimTime: TimeStamp?

  • Timestamp that indicates the last time the game server was updated with health status using an UpdateGameServer request. The format is a number expressed in Unix time as milliseconds (for example “1469498468.057”). After game server registration, this property is only changed when a game server update specifies a health check value.

    Declaration

    Swift

    public let lastHealthCheckTime: TimeStamp?

  • Timestamp that indicates when the game server was created with a RegisterGameServer request. The format is a number expressed in Unix time as milliseconds (for example “1469498468.057”).

    Declaration

    Swift

    public let registrationTime: TimeStamp?

  • Indicates whether the game server is currently available for new games or is busy. Possible statuses include: AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity. UTILIZED - The game server is currently hosting a game session with players.

    Declaration

    Swift

    public let utilizationStatus: GameServerUtilizationStatus?

  • Undocumented

    Declaration

    Swift

    public init(claimStatus: GameServerClaimStatus? = nil, connectionInfo: String? = nil, gameServerData: String? = nil, gameServerGroupArn: String? = nil, gameServerGroupName: String? = nil, gameServerId: String? = nil, instanceId: String? = nil, lastClaimTime: TimeStamp? = nil, lastHealthCheckTime: TimeStamp? = nil, registrationTime: TimeStamp? = nil, utilizationStatus: GameServerUtilizationStatus? = nil)