Class: Aws::GameLift::Types::MatchmakingConfiguration

Inherits:

Struct

Object
Struct
Aws::GameLift::Types::MatchmakingConfiguration

show all

Includes:: Structure

Defined in:: lib/aws-sdk-gamelift/types.rb

Overview

Guidelines for use with FlexMatch to match players into games. All matchmaking requests must specify a matchmaking configuration.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#acceptance_required ⇒ Boolean

A flag that indicates whether a match that was created with this configuration must be accepted by the matched players.
#acceptance_timeout_seconds ⇒ Integer

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
#additional_player_count ⇒ Integer

The number of player slots in a match to keep open for future players.
#backfill_mode ⇒ String

The method used to backfill game sessions created with this matchmaking configuration.
#configuration_arn ⇒ String

The Amazon Resource Name ([ARN]) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
#creation_time ⇒ Time

A time stamp indicating when this data object was created.
#custom_event_data ⇒ String

Information to attach to all events related to the matchmaking configuration.
#description ⇒ String

A descriptive label that is associated with matchmaking configuration.
#flex_match_mode ⇒ String

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
#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_queue_arns ⇒ Array<String>

The Amazon Resource Name ([ARN]) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
#name ⇒ String

A unique identifier for the matchmaking configuration.
#notification_target ⇒ String

An SNS topic ARN that is set up to receive matchmaking notifications.
#request_timeout_seconds ⇒ Integer

The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
#rule_set_arn ⇒ String

The Amazon Resource Name ([ARN]) associated with the GameLift matchmaking rule set resource that this configuration uses.
#rule_set_name ⇒ String

A unique identifier for the matchmaking rule set to use with this configuration.

Instance Attribute Details

#acceptance_required ⇒ `Boolean`

A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. When this option is enabled, matchmaking tickets use the status ‘REQUIRES_ACCEPTANCE` to indicate when a completed potential match is waiting for player acceptance.

Returns:

(Boolean)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

#acceptance_timeout_seconds ⇒ `Integer`

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

Returns:

(Integer)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

#additional_player_count ⇒ `Integer`

The number of player slots in a match to keep open for future players. For example, if the configuration’s rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used when ‘FlexMatchMode` is set to `STANDALONE`.

Returns:

(Integer)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

#backfill_mode ⇒ `String`

The method used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates backfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in [Backfill existing games with FlexMatch]. Automatic backfill is not available when ‘FlexMatchMode` is set to `STANDALONE`.

[1]: docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html

Returns:

(String)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_arn ⇒ `String`

The Amazon Resource Name ([ARN]) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. Format is ‘arn:aws:gamelift:<region>::matchmakingconfiguration/<matchmaking configuration name>`. In a Amazon GameLift configuration ARN, the resource ID matches the Name value.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html

Returns:

(String)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ `Time`

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example ‘“1469498468.057”`).

Returns:

(Time)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

#custom_event_data ⇒ `String`

Information to attach to all events related to the matchmaking configuration.

Returns:

(String)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A descriptive label that is associated with matchmaking configuration.

Returns:

(String)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

#flex_match_mode ⇒ `String`

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a [ MatchmakingSucceeded] event.
WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

[1]: docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded

Returns:

(String)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  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”`. This information is added to the new `GameSession` object that is created for a successful match. This parameter is not used when `FlexMatchMode` is set to `STANDALONE`.

Returns:

(Array<Types::GameProperty>)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  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]. This information is added to the new ‘GameSession` object that is created for a successful match. This parameter is not used when `FlexMatchMode` is set to `STANDALONE`.

[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 8629

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

#game_session_queue_arns ⇒ `Array<String>`

The Amazon Resource Name ([ARN]) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is ‘arn:aws:gamelift:<region>::gamesessionqueue/<queue name>`. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. This property is not set when `FlexMatchMode` is set to `STANDALONE`.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html

Returns:

(Array<String>)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

Returns:

(String)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

#notification_target ⇒ `String`

An SNS topic ARN that is set up to receive matchmaking notifications.

Returns:

(String)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

#request_timeout_seconds ⇒ `Integer`

The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

Returns:

(Integer)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

#rule_set_arn ⇒ `String`

The Amazon Resource Name ([ARN]) associated with the GameLift matchmaking rule set resource that this configuration uses.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html

Returns:

(String)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

#rule_set_name ⇒ `String`

A unique identifier for the matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same Region.

Returns:

(String)

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

class MatchmakingConfiguration < Struct.new(
  :name,
  :configuration_arn,
  :description,
  :game_session_queue_arns,
  :request_timeout_seconds,
  :acceptance_timeout_seconds,
  :acceptance_required,
  :rule_set_name,
  :rule_set_arn,
  :notification_target,
  :additional_player_count,
  :custom_event_data,
  :creation_time,
  :game_properties,
  :game_session_data,
  :backfill_mode,
  :flex_match_mode)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::GameLift::Types::MatchmakingConfiguration

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#acceptance_required ⇒ Boolean

#acceptance_timeout_seconds ⇒ Integer

#additional_player_count ⇒ Integer

#backfill_mode ⇒ String

#configuration_arn ⇒ String

#creation_time ⇒ Time

#custom_event_data ⇒ String

#description ⇒ String

#flex_match_mode ⇒ String

#game_properties ⇒ Array<Types::GameProperty>

#game_session_data ⇒ String

#game_session_queue_arns ⇒ Array<String>

#name ⇒ String

#notification_target ⇒ String

#request_timeout_seconds ⇒ Integer

#rule_set_arn ⇒ String

#rule_set_name ⇒ String

#acceptance_required ⇒ `Boolean`

#acceptance_timeout_seconds ⇒ `Integer`

#additional_player_count ⇒ `Integer`

#backfill_mode ⇒ `String`

#configuration_arn ⇒ `String`

#creation_time ⇒ `Time`

#custom_event_data ⇒ `String`

#description ⇒ `String`

#flex_match_mode ⇒ `String`

#game_properties ⇒ `Array<Types::GameProperty>`

#game_session_data ⇒ `String`

#game_session_queue_arns ⇒ `Array<String>`

#name ⇒ `String`

#notification_target ⇒ `String`

#request_timeout_seconds ⇒ `Integer`

#rule_set_arn ⇒ `String`

#rule_set_name ⇒ `String`