NAME
Paws::GameLift::CreateGameSession - Arguments for method CreateGameSession on Paws::GameLift
DESCRIPTION
This class represents the parameters used for calling the method CreateGameSession on the Amazon GameLift service. Use the attributes of this class as arguments to method CreateGameSession.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateGameSession.
SYNOPSIS
my $gamelift = Paws->service('GameLift');
my $CreateGameSessionOutput = $gamelift->CreateGameSession(
MaximumPlayerSessionCount => 1,
AliasId => 'MyAliasId', # OPTIONAL
CreatorId => 'MyNonZeroAndMaxString', # OPTIONAL
FleetId => 'MyFleetId', # OPTIONAL
GameProperties => [
{
Key => 'MyGamePropertyKey', # max: 32
Value => 'MyGamePropertyValue', # max: 96
},
...
], # OPTIONAL
GameSessionData => 'MyGameSessionData', # OPTIONAL
GameSessionId => 'MyIdStringModel', # OPTIONAL
IdempotencyToken => 'MyIdStringModel', # OPTIONAL
Name => 'MyNonZeroAndMaxString', # OPTIONAL
);
# Results:
my $GameSession = $CreateGameSessionOutput->GameSession;
# Returns a L<Paws::GameLift::CreateGameSessionOutput> object.Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/gamelift/CreateGameSession
ATTRIBUTES
AliasId => Str
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.
CreatorId => Str
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.
FleetId => Str
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.
GameProperties => ArrayRef[Paws::GameLift::GameProperty]
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 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)).
GameSessionData => Str
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 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)).
GameSessionId => Str
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>.)
IdempotencyToken => Str
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.
REQUIRED MaximumPlayerSessionCount => Int
The maximum number of players that can be connected simultaneously to the game session.
Name => Str
A descriptive label that is associated with a game session. Session names do not need to be unique.
SEE ALSO
This class forms part of Paws, documenting arguments for method CreateGameSession in Paws::GameLift
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues