class Aws::GameLift::Types::CreateGameSessionInput

Represents the input for a request operation.

@note When making an API call, you may pass CreateGameSessionInput

data as a hash:

    {
      fleet_id: "FleetIdOrArn",
      alias_id: "AliasIdOrArn",
      maximum_player_session_count: 1, # required
      name: "NonZeroAndMaxString",
      game_properties: [
        {
          key: "GamePropertyKey", # required
          value: "GamePropertyValue", # required
        },
      ],
      creator_id: "NonZeroAndMaxString",
      game_session_id: "IdStringModel",
      idempotency_token: "IdStringModel",
      game_session_data: "LargeGameSessionData",
      location: "LocationStringModel",
    }

@!attribute [rw] fleet_id

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.
@return [String]

@!attribute [rw] alias_id

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.
@return [String]

@!attribute [rw] maximum_player_session_count

The maximum number of players that can be connected simultaneously
to the game session.
@return [Integer]

@!attribute [rw] name

A descriptive label that is associated with a game session. Session
names do not need to be unique.
@return [String]

@!attribute [rw] game_properties

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.
@return [Array<Types::GameProperty>]

@!attribute [rw] creator_id

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.
@return [String]

@!attribute [rw] game_session_id

*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.
@return [String]

@!attribute [rw] idempotency_token

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.
@return [String]

@!attribute [rw] game_session_data

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.
@return [String]

@!attribute [rw] location

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`.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameSessionInput AWS API Documentation

Constants

SENSITIVE