AWS CDK Reference

Appearance

v2.275.0

Experimental

@aws-cdk/aws-gamelift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

QueuedMatchmakingConfigurationProps Struct ​

Properties for a new queued matchmaking configuration.

Stability
Experimental
Source
lib/queued-matchmaking-configuration.ts

Example ​

ts
declare const queue: gamelift.GameSessionQueue;
declare const ruleSet: gamelift.MatchmakingRuleSet;

new gamelift.QueuedMatchmakingConfiguration(this, 'QueuedMatchmakingConfiguration', {
  matchmakingConfigurationName: 'test-queued-config-name',
  gameSessionQueues: [queue],
  ruleSet: ruleSet,
});

Properties ​

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

Default: 300 seconds

additionalPlayerCountoptionalnumberadditional_player_countoptionalint | floatadditionalPlayerCountoptionalNumberAdditionalPlayerCountoptionaldoubleAdditionalPlayerCountoptional*float64#
The number of player slots in a match to keep open for future players.

Default: no additional player slots

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.

customEventDataoptionalstringcustom_event_dataoptionalstrcustomEventDataoptionalStringCustomEventDataoptionalstringCustomEventDataoptional*string#
Information to add to all events related to the matchmaking configuration.

Default: no custom data added to events

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A human-readable description of the matchmaking configuration.

Default: no description is provided

gamePropertiesoptionalGameProperty[]game_propertiesoptionaltyping.List[GameProperty]gamePropertiesoptionalList<GameProperty>GamePropertiesoptionalGameProperty[]GamePropertiesoptional*[]GameProperty#
A set of custom properties for a game session, formatted as key-value pairs.

Default: no additional game properties

These properties are passed to a game server process with a request to start a new game session.

gameSessionDataoptionalstringgame_session_dataoptionalstrgameSessionDataoptionalStringGameSessionDataoptionalstringGameSessionDataoptional*string#
A set of custom game session properties, formatted as a single string value.

Default: no additional game session data

This data is passed to a game server process with a request to start a new game session.

gameSessionQueuesIGameSessionQueue[]game_session_queuestyping.List[IGameSessionQueue]gameSessionQueuesList<IGameSessionQueue>GameSessionQueuesIGameSessionQueue[]GameSessionQueues*[]IGameSessionQueuerequired#
Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration.

Queues can be located in any Region.

manualBackfillModeoptionalbooleanmanual_backfill_modeoptionalboolmanualBackfillModeoptionalBooleanManualBackfillModeoptionalboolManualBackfillModeoptional*bool#
The method used to backfill game sessions that are created with this matchmaking configuration.

Default: automatic backfill mode

notes
  • Choose manual when your game manages backfill requests manually or does not use the match backfill feature.
  • Otherwise backfill is settled to automatic to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots.
matchmakingConfigurationNamestringmatchmaking_configuration_namestrmatchmakingConfigurationNameStringMatchmakingConfigurationNamestringMatchmakingConfigurationName*stringrequired#
A unique identifier for the matchmaking configuration.

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

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

Default: no notification target

requestTimeoutoptionalDurationrequest_timeoutoptionalDurationrequestTimeoutoptionalDurationRequestTimeoutoptionalDurationRequestTimeoutoptionalDuration#
The maximum duration, that a matchmaking ticket can remain in process before timing out.

Default: 300 seconds

Requests that fail due to timing out can be resubmitted as needed.

requireAcceptanceoptionalbooleanrequire_acceptanceoptionalboolrequireAcceptanceoptionalBooleanRequireAcceptanceoptionalboolRequireAcceptanceoptional*bool#
A flag that determines whether a match that was created with this configuration must be accepted by the matched players.

Default: Acceptance is not required

With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

ruleSetIMatchmakingRuleSetrule_setIMatchmakingRuleSetruleSetIMatchmakingRuleSetRuleSetIMatchmakingRuleSetRuleSetIMatchmakingRuleSetrequired#
A matchmaking rule set to use with this configuration.

A matchmaking configuration can only use rule sets that are defined in the same Region.