CreateGameSessionInput Structure Reference


                    
                    
                    _members

Declaration

Swift

public static var _members: [AWSShapeMember]


                    
                    
                    aliasId

A unique identifier for an 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.

Declaration

Swift

public let aliasId: String?


                    
                    
                    creatorId

A unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

Declaration

Swift

public let creatorId: String?


                    
                    
                    fleetId

A unique identifier for a 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.

Declaration

Swift

public let fleetId: String?


                    
                    
                    gameProperties

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]?


                    
                    
                    gameSessionData

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?


                    
                    
                    gameSessionId

This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. 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:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)

Declaration

Swift

public let gameSessionId: String?


                    
                    
                    idempotencyToken

Custom string that uniquely identifies a request for a new game session. 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:<region>::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.

Declaration

Swift

public let idempotencyToken: String?


                    
                    
                    maximumPlayerSessionCount

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

Declaration

Swift

public let maximumPlayerSessionCount: Int


                    
                    
                    name

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

Declaration

Swift

public let name: String?


                    
                    
                    init(aliasId:creatorId:fleetId:gameProperties:gameSessionData:gameSessionId:idempotencyToken:maximumPlayerSessionCount:name:)

Undocumented

Declaration

Swift

public init(aliasId: String? = nil, creatorId: String? = nil, fleetId: String? = nil, gameProperties: [GameProperty]? = nil, gameSessionData: String? = nil, gameSessionId: String? = nil, idempotencyToken: String? = nil, maximumPlayerSessionCount: Int, name: String? = nil)


                    
                    
                    validate(name:)

Declaration

Swift

public func validate(name: String) throws