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                   => 'MyAliasIdOrArn',           # OPTIONAL
      CreatorId                 => 'MyNonZeroAndMaxString',    # OPTIONAL
      FleetId                   => 'MyFleetIdOrArn',           # OPTIONAL
      GameProperties            => [
        {
          Key   => 'MyGamePropertyKey',      # max: 32
          Value => 'MyGamePropertyValue',    # max: 96
        },
        ...
      ],    # OPTIONAL
      GameSessionData  => 'MyLargeGameSessionData',    # OPTIONAL
      GameSessionId    => 'MyIdStringModel',           # OPTIONAL
      IdempotencyToken => 'MyIdStringModel',           # OPTIONAL
      Location         => 'MyLocationStringModel',     # 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 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 => Str

A unique identifier for a player or entity creating the game session. This parameter is required when requesting a new game session on a fleet with a resource creation limit policy. This type of policy limits the number of concurrent active game sessions that one player can create within a certain time span. GameLift uses the CreatorId to evaluate the new request against the policy.

FleetId => Str

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 => ArrayRef[Paws::GameLift::GameProperty]

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.

GameSessionData => Str

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.

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.

IdempotencyToken => Str

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:<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.

Location => Str

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 AWS Region code such as "us-west-2".

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.

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>