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

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: "FleetId",
  alias_id: "AliasId",
  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 action.

Instance Attribute Summary collapse

Instance Attribute Details

#alias_idString

Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 671

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)
  include Aws::Structure
end

#creator_idString

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)


671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 671

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)
  include Aws::Structure
end

#fleet_idString

Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 671

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)
  include Aws::Structure
end

#game_propertiesArray<Types::GameProperty>

Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

Returns:



671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 671

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)
  include Aws::Structure
end

#game_session_dataString

Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 671

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)
  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. (A game session ID has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 671

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)
  include Aws::Structure
end

#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 ID 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)


671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 671

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)
  include Aws::Structure
end

#maximum_player_session_countInteger

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

Returns:

  • (Integer)


671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 671

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)
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 671

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)
  include Aws::Structure
end