class Aws::GameLift::Types::MatchmakingConfiguration

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

@!attribute [rw] name

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

@!attribute [rw] configuration_arn

The Amazon Resource Name ([ARN][1]) that is assigned to a 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 GameLift configuration ARN, the resource
ID matches the *Name* value.

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

@!attribute [rw] description

A descriptive label that is associated with matchmaking
configuration.
@return [String]

@!attribute [rw] game_session_queue_arns

The Amazon Resource Name ([ARN][1]) that is assigned to a 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
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]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
@return [Array<String>]

@!attribute [rw] request_timeout_seconds

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.
@return [Integer]

@!attribute [rw] acceptance_timeout_seconds

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.
@return [Integer]

@!attribute [rw] acceptance_required

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.
@return [Boolean]

@!attribute [rw] rule_set_name

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.
@return [String]

@!attribute [rw] rule_set_arn

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

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

@!attribute [rw] notification_target

An SNS topic ARN that is set up to receive matchmaking
notifications.
@return [String]

@!attribute [rw] additional_player_count

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`.
@return [Integer]

@!attribute [rw] custom_event_data

Information to attach to all events related to the matchmaking
configuration.
@return [String]

@!attribute [rw] creation_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"`).
@return [Time]

@!attribute [rw] game_properties

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 (see [Start a Game Session][1]). 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]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
@return [Array<Types::GameProperty>]

@!attribute [rw] game_session_data

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 (see
[Start a Game Session][1]). 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]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
@return [String]

@!attribute [rw] backfill_mode

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 StartMatchBackfill
requests whenever a game session has one or more open slots. Learn
more about manual and automatic backfill in [Backfill existing games
with FlexMatch][1]. Automatic backfill is not available when
`FlexMatchMode` is set to `STANDALONE`.

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

@!attribute [rw] flex_match_mode

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

* **STANDALONE** - FlexMatch forms matches and returns match
  information, including players and team assignments, in a [
  MatchmakingSucceeded][1] event.

* **WITH\_QUEUE** - FlexMatch forms matches and uses the specified
  GameLift queue to start a game session for the match.

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

@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/MatchmakingConfiguration AWS API Documentation

Constants

SENSITIVE