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

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::CreateGameSessionInput

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alias_id ⇒ String

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

• #creator_id ⇒ String

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

• #fleet_id ⇒ String

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

• #game_properties ⇒ Array<Types::GameProperty>

  A set of key-value pairs that can store custom data in a game session.

• #game_session_data ⇒ String

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

• #game_session_id ⇒ String

  *This parameter is deprecated.

• #idempotency_token ⇒ String

  Custom string that uniquely identifies the new game session request.

• #location ⇒ String

  A fleet’s remote location to place the new game session in.

• #maximum_player_session_count ⇒ Integer

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

• #name ⇒ String

  A descriptive label that is associated with a game session.

Instance Attribute Details

#alias_id ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2548

class CreateGameSessionInput < Struct.new(
  :fleet_id,
  :alias_id,
  :maximum_player_session_count,
  :name,
  :game_properties,
  :creator_id,
  :game_session_id,
  :idempotency_token,
  :game_session_data,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#creator_id ⇒ String

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

If you add a resource creation limit policy to a fleet, the ‘CreateGameSession` operation requires a `CreatorId`. Amazon GameLift Servers limits the number of game session creation requests with the same `CreatorId` in a specified time period.

If you your fleet doesn’t have a resource creation limit policy and you provide a ‘CreatorId` in your `CreateGameSession` requests, Amazon GameLift Servers limits requests to one request per `CreatorId` per second.

To not limit ‘CreateGameSession` requests with the same `CreatorId`, don’t provide a ‘CreatorId` in your `CreateGameSession` request.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2548

class CreateGameSessionInput < Struct.new(
  :fleet_id,
  :alias_id,
  :maximum_player_session_count,
  :name,
  :game_properties,
  :creator_id,
  :game_session_id,
  :idempotency_token,
  :game_session_data,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#fleet_id ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2548

class CreateGameSessionInput < Struct.new(
  :fleet_id,
  :alias_id,
  :maximum_player_session_count,
  :name,
  :game_properties,
  :creator_id,
  :game_session_id,
  :idempotency_token,
  :game_session_data,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#game_properties ⇒ Array<Types::GameProperty>

A set of key-value pairs that can store custom data in a game session. For example: ‘“difficulty”, “Value”: “novice”`. For an example, see [Create a game session with custom properties].

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-create

Returns:

• (Array<Types::GameProperty>)

# File 'lib/aws-sdk-gamelift/types.rb', line 2548

class CreateGameSessionInput < Struct.new(
  :fleet_id,
  :alias_id,
  :maximum_player_session_count,
  :name,
  :game_properties,
  :creator_id,
  :game_session_id,
  :idempotency_token,
  :game_session_data,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#game_session_data ⇒ String

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. For more information, see [Start a game session].

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2548

class CreateGameSessionInput < Struct.new(
  :fleet_id,
  :alias_id,
  :maximum_player_session_count,
  :name,
  :game_properties,
  :creator_id,
  :game_session_id,
  :idempotency_token,
  :game_session_data,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#game_session_id ⇒ String

*This parameter is deprecated. 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.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2548

class CreateGameSessionInput < Struct.new(
  :fleet_id,
  :alias_id,
  :maximum_player_session_count,
  :name,
  :game_properties,
  :creator_id,
  :game_session_id,
  :idempotency_token,
  :game_session_data,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#idempotency_token ⇒ String

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:<location>::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)

# File 'lib/aws-sdk-gamelift/types.rb', line 2548

class CreateGameSessionInput < Struct.new(
  :fleet_id,
  :alias_id,
  :maximum_player_session_count,
  :name,
  :game_properties,
  :creator_id,
  :game_session_id,
  :idempotency_token,
  :game_session_data,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#location ⇒ String

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 Amazon Web Services Region code such as ‘us-west-2`. When using an Anywhere fleet, this parameter is required and must be set to the Anywhere fleet’s custom location.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2548

class CreateGameSessionInput < Struct.new(
  :fleet_id,
  :alias_id,
  :maximum_player_session_count,
  :name,
  :game_properties,
  :creator_id,
  :game_session_id,
  :idempotency_token,
  :game_session_data,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_player_session_count ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-gamelift/types.rb', line 2548

class CreateGameSessionInput < Struct.new(
  :fleet_id,
  :alias_id,
  :maximum_player_session_count,
  :name,
  :game_properties,
  :creator_id,
  :game_session_id,
  :idempotency_token,
  :game_session_data,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2548

class CreateGameSessionInput < Struct.new(
  :fleet_id,
  :alias_id,
  :maximum_player_session_count,
  :name,
  :game_properties,
  :creator_id,
  :game_session_id,
  :idempotency_token,
  :game_session_data,
  :location)
  SENSITIVE = []
  include Aws::Structure
end