@aws-cdk_aws-gamelift-alpha.StandaloneMatchmakingConfigurationProps

interface StandaloneMatchmakingConfigurationProps ๐Ÿ”น

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

Properties for a new standalone matchmaking configuration.

Example

declare const ruleSet: gamelift.MatchmakingRuleSet;

new gamelift.StandaloneMatchmakingConfiguration(this, 'StandaloneMatchmaking', {
  matchmakingConfigurationName: 'test-standalone-config-name',
  ruleSet: ruleSet,
});

Properties

NameTypeDescription
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.
customEventData?๐Ÿ”นstringInformation to add to all events related to the matchmaking configuration.
description?๐Ÿ”นstringA human-readable description of the 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.

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.


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.


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.