/AWS1/CL_GML=>CREATEMATCHMAKINGCONF()

About CreateMatchmakingConfiguration

Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with Amazon GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using Amazon GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes consistent with that configuration.

To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without Amazon GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with Amazon GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.

In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration.

Learn more

Design a FlexMatch matchmaker

Set up FlexMatch event notification

Method Signature

IMPORTING

Required arguments:

IV_NAME TYPE /AWS1/GMLMATCHMAKINGIDSTRMODEL /AWS1/GMLMATCHMAKINGIDSTRMODEL

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

IV_REQUESTTIMEOUTSECONDS TYPE /AWS1/GMLMATCHMAKINGREQTOINT00 /AWS1/GMLMATCHMAKINGREQTOINT00

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.

IV_ACCEPTANCEREQUIRED TYPE /AWS1/GMLBOOLEANMODEL /AWS1/GMLBOOLEANMODEL

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

IV_RULESETNAME TYPE /AWS1/GMLMATCHMAKINGRLSETNAME /AWS1/GMLMATCHMAKINGRLSETNAME

A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

Optional arguments:

IV_DESCRIPTION TYPE /AWS1/GMLNONZEROANDMAXSTRING /AWS1/GMLNONZEROANDMAXSTRING

A human-readable description of the matchmaking configuration.

IT_GAMESESSIONQUEUEARNS TYPE /AWS1/CL_GMLQUEUEARNSLIST_W=>TT_QUEUEARNSLIST TT_QUEUEARNSLIST

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:::gamesessionqueue/. 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. If FlexMatchMode is set to STANDALONE, do not set this parameter.

IV_ACCEPTANCETIMEOUTSECONDS TYPE /AWS1/GMLMATCHMAKINGACCANCET00 /AWS1/GMLMATCHMAKINGACCANCET00

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

IV_NOTIFICATIONTARGET TYPE /AWS1/GMLSNSARNSTRINGMODEL /AWS1/GMLSNSARNSTRINGMODEL

An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up notifications for matchmaking for more information.

IV_ADDITIONALPLAYERCOUNT TYPE /AWS1/GMLWHOLENUMBER /AWS1/GMLWHOLENUMBER

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 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. This parameter is not used if FlexMatchMode is set to STANDALONE.

IV_CUSTOMEVENTDATA TYPE /AWS1/GMLCUSTOMEVENTDATA /AWS1/GMLCUSTOMEVENTDATA

Information to be added to all events related to this matchmaking configuration.

IT_GAMEPROPERTIES TYPE /AWS1/CL_GMLGAMEPROPERTY=>TT_GAMEPROPERTYLIST TT_GAMEPROPERTYLIST

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

IV_GAMESESSIONDATA TYPE /AWS1/GMLGAMESESSIONDATA /AWS1/GMLGAMESESSIONDATA

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 (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 if FlexMatchMode is set to STANDALONE.

IV_BACKFILLMODE TYPE /AWS1/GMLBACKFILLMODE /AWS1/GMLBACKFILLMODE

The method used to backfill game sessions that are created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have Amazon GameLift create a backfill request 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.

IV_FLEXMATCHMODE TYPE /AWS1/GMLFLEXMATCHMODE /AWS1/GMLFLEXMATCHMODE

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.

IT_TAGS TYPE /AWS1/CL_GMLTAG=>TT_TAGLIST TT_TAGLIST

A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_GMLCREMATCHMAKINGCO01 /AWS1/CL_GMLCREMATCHMAKINGCO01