Skip to content
v2.277.0

Experimental

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

StandaloneMatchmakingConfigurationProps Struct ​

Properties for a new standalone matchmaking configuration.

Example ​

ts
declare const ruleSet: gamelift.MatchmakingRuleSet;

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


gamelift.StandaloneMatchmakingConfiguration(self, "StandaloneMatchmaking",
    matchmaking_configuration_name="test-standalone-config-name",
    rule_set=rule_set
)
java
MatchmakingRuleSet ruleSet;


StandaloneMatchmakingConfiguration.Builder.create(this, "StandaloneMatchmaking")
        .matchmakingConfigurationName("test-standalone-config-name")
        .ruleSet(ruleSet)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.GameLift.Alpha
MatchmakingRuleSet ruleSet;


new StandaloneMatchmakingConfiguration(this, "StandaloneMatchmaking", new StandaloneMatchmakingConfigurationProps {
    MatchmakingConfigurationName = "test-standalone-config-name",
    RuleSet = ruleSet
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2
var ruleSet MatchmakingRuleSet


gamelift.NewStandaloneMatchmakingConfiguration(this, jsii.String("StandaloneMatchmaking"), &StandaloneMatchmakingConfigurationProps{
	MatchmakingConfigurationName: jsii.String("test-standalone-config-name"),
	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

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

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.

A matchmaking rule set to use with this configuration.

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