AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::CreateGameSessionInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateGameSessionInput as input to an Aws::Client method, you can use a vanilla 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: "GameSessionData",
}

Represents the input for a request operation.

Instance Attribute Summary collapse

Instance Attribute Details

#alias_idString

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.

Returns:

  • (String)

    A unique identifier for an alias associated with the fleet to create a game session in.

#creator_idString

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.

Returns:

  • (String)

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

#fleet_idString

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.

Returns:

  • (String)

    A unique identifier for a fleet to create a game session in.

#game_propertiesArray<Types::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).

Returns:

  • (Array<Types::GameProperty>)

    Set of custom properties for a game session, formatted as key:value pairs.

#game_session_dataString

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

Returns:

  • (String)

    Set of custom game session properties, formatted as a single string value.

#game_session_idString

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

Returns:

  • (String)

    *This parameter is no longer preferred.

#idempotency_tokenString

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.

Returns:

  • (String)

    Custom string that uniquely identifies a request for a new game session.

#maximum_player_session_countInteger

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

Returns:

  • (Integer)

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

#nameString

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

Returns:

  • (String)

    A descriptive label that is associated with a game session.