StartGameSessionPlacementInput

import type { StartGameSessionPlacementInput } from "https://aws-api.deno.dev/v0.3/services/gamelift.ts?docs=full";

Represents the input for a request operation.

interface StartGameSessionPlacementInput {

DesiredPlayerSessions?: DesiredPlayerSession[] | null;

GameProperties?: GameProperty[] | null;

GameSessionData?: string | null;

GameSessionName?: string | null;

GameSessionQueueName: string;

MaximumPlayerSessionCount: number;

PlacementId: string;

PlayerLatencies?: PlayerLatency[] | null;

}

§Properties

DesiredPlayerSessions?: DesiredPlayerSession[] | null

[src]

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

GameProperties?: GameProperty[] | null

[src]

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

GameSessionData?: string | null

[src]

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

GameSessionName?: string | null

[src]

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

GameSessionQueueName: string

[src]

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

MaximumPlayerSessionCount: number

[src]

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

PlacementId: string

[src]

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.

PlayerLatencies?: PlayerLatency[] | null

[src]

A set of values, expressed in milliseconds, that indicates 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.