gamelift/aws.sdk.kotlin.services.gamelift.model/CreateGameSessionRequest/Builder

Builder

Properties

A unique identifier for the alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

creatorId

var creatorId: String?

A unique identifier for a player or entity creating the game session.

fleetId

var fleetId: String?

A unique identifier for the fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

gameProperties

var gameProperties: List<GameProperty>?

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. For an example, see Create a game session with custom properties.

gameSessionData

var gameSessionData: String?

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. For more information, see Start a game session.

gameSessionId

var gameSessionId: String?

This parameter is deprecated. Use IdempotencyToken instead.

idempotencyToken

var idempotencyToken: String?

Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original GameSession object, with an updated status. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. A game session ARN has the following format: arn:aws:gamelift:<location>::gamesession/<fleet ID>/<custom ID string or idempotency token>. Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

location

var location: String?

A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an Amazon Web Services Region code such as us-west-2. When using an Anywhere fleet, this parameter is required and must be set to the Anywhere fleet's custom location.

maximumPlayerSessionCount

var maximumPlayerSessionCount: Int?

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

name

var name: String?

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