@aws-cdk_aws-gamelift-alpha.QueuedMatchmakingConfigurationProps

interface QueuedMatchmakingConfigurationProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.GameLift.Alpha.QueuedMatchmakingConfigurationProps
Gogithub.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#QueuedMatchmakingConfigurationProps
Javasoftware.amazon.awscdk.services.gamelift.alpha.QueuedMatchmakingConfigurationProps
Pythonaws_cdk.aws_gamelift_alpha.QueuedMatchmakingConfigurationProps
TypeScript (source)@aws-cdk/aws-gamelift-alpha ยป QueuedMatchmakingConfigurationProps

Properties for a new queued matchmaking configuration.

Example

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

NameTypeDescription
gameSessionQueues๐Ÿ”นIGameSessionQueue[]Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration.
matchmakingConfigurationName๐Ÿ”นstringA unique identifier for the matchmaking configuration.
ruleSet๐Ÿ”นIMatchmakingRuleSetA matchmaking rule set to use with this configuration.
acceptanceTimeout?๐Ÿ”นDurationThe length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
additionalPlayerCount?๐Ÿ”นnumberThe number of player slots in a match to keep open for future players.
customEventData?๐Ÿ”นstringInformation to add to all events related to the matchmaking configuration.
description?๐Ÿ”นstringA human-readable description of the matchmaking configuration.
gameProperties?๐Ÿ”นGameProperty[]A set of custom properties for a game session, formatted as key-value pairs.
gameSessionData?๐Ÿ”นstringA set of custom game session properties, formatted as a single string value.
manualBackfillMode?๐Ÿ”นbooleanThe method used to backfill game sessions that are created with this matchmaking configuration.
notificationTarget?๐Ÿ”นITopicAn SNS topic ARN that is set up to receive matchmaking notifications.
requestTimeout?๐Ÿ”นDurationThe maximum duration, that a matchmaking ticket can remain in process before timing out.
requireAcceptance?๐Ÿ”นbooleanA flag that determines whether a match that was created with this configuration must be accepted by the matched players.

gameSessionQueues๐Ÿ”น

Type: IGameSessionQueue[]

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.


matchmakingConfigurationName๐Ÿ”น

Type: string

A unique identifier for the matchmaking configuration.

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


ruleSet๐Ÿ”น

Type: IMatchmakingRuleSet

A matchmaking rule set to use with this configuration.

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


acceptanceTimeout?๐Ÿ”น

Type: Duration (optional, default: 300 seconds)

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


additionalPlayerCount?๐Ÿ”น

Type: number (optional, default: no additional player slots)

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.


customEventData?๐Ÿ”น

Type: string (optional, default: no custom data added to events)

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


description?๐Ÿ”น

Type: string (optional, default: no description is provided)

A human-readable description of the matchmaking configuration.


gameProperties?๐Ÿ”น

Type: GameProperty[] (optional, default: no additional 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 with a request to start a new game session.

See also: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession


gameSessionData?๐Ÿ”น

Type: string (optional, default: no additional 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 with a request to start a new game session.

See also: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession


manualBackfillMode?๐Ÿ”น

Type: boolean (optional, default: automatic backfill mode)

The method used to backfill game sessions that are created with this matchmaking configuration.

  • 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.

See also: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html


notificationTarget?๐Ÿ”น

Type: ITopic (optional, default: no notification target)

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

See also: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html


requestTimeout?๐Ÿ”น

Type: Duration (optional, default: 300 seconds)

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

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


requireAcceptance?๐Ÿ”น

Type: boolean (optional, default: Acceptance is not required)

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

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