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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

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",
}

Represents the input for a request operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alias_idString

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)


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1273

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_idString

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.

Returns:

  • (String)


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1273

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_idString

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)


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1273

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

Returns:



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1273

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_dataString

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.

Returns:

  • (String)


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1273

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

Returns:

  • (String)


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1273

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_tokenString

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.

Returns:

  • (String)


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1273

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

#locationString

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.

Returns:

  • (String)


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1273

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_countInteger

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

Returns:

  • (Integer)


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1273

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

#nameString

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

Returns:

  • (String)


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1273

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