StartGameSessionPlacementInput

public struct StartGameSessionPlacementInput : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Set of information on each player to create a player session for.

    Declaration

    Swift

    public let desiredPlayerSessions: [DesiredPlayerSession]?

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

    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 descriptive label that is associated with a game session. Session names do not need to be unique.

    Declaration

    Swift

    public let gameSessionName: String?

  • Name of the queue to use to place the new game session. You can use either the queue name or ARN value.

    Declaration

    Swift

    public let gameSessionQueueName: String

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

    Declaration

    Swift

    public let maximumPlayerSessionCount: Int

  • A unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all Regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

    Declaration

    Swift

    public let placementId: String

  • Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS Regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

    Declaration

    Swift

    public let playerLatencies: [PlayerLatency]?

  • Undocumented

    Declaration

    Swift

    public init(desiredPlayerSessions: [DesiredPlayerSession]? = nil, gameProperties: [GameProperty]? = nil, gameSessionData: String? = nil, gameSessionName: String? = nil, gameSessionQueueName: String, maximumPlayerSessionCount: Int, placementId: String, playerLatencies: [PlayerLatency]? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws