interface MatchmakingConfigurationProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.GameLift.Alpha.MatchmakingConfigurationProps |
![]() | github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#MatchmakingConfigurationProps |
![]() | software.amazon.awscdk.services.gamelift.alpha.MatchmakingConfigurationProps |
![]() | aws_cdk.aws_gamelift_alpha.MatchmakingConfigurationProps |
![]() | @aws-cdk/aws-gamelift-alpha ยป MatchmakingConfigurationProps |
Properties for a new Gamelift matchmaking configuration.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';
import * as cdk from 'aws-cdk-lib';
import { aws_sns as sns } from 'aws-cdk-lib';
declare const matchmakingRuleSet: gamelift_alpha.MatchmakingRuleSet;
declare const topic: sns.Topic;
const matchmakingConfigurationProps: gamelift_alpha.MatchmakingConfigurationProps = {
matchmakingConfigurationName: 'matchmakingConfigurationName',
ruleSet: matchmakingRuleSet,
// the properties below are optional
acceptanceTimeout: cdk.Duration.minutes(30),
customEventData: 'customEventData',
description: 'description',
notificationTarget: topic,
requestTimeout: cdk.Duration.minutes(30),
requireAcceptance: false,
};
Properties
Name | Type | Description |
---|---|---|
matchmaking | string | A unique identifier for the matchmaking configuration. |
rule | IMatchmaking | A matchmaking rule set to use with this configuration. |
acceptance | Duration | The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. |
custom | string | Information to add to all events related to the matchmaking configuration. |
description? | string | A human-readable description of the matchmaking configuration. |
notification | ITopic | An SNS topic ARN that is set up to receive matchmaking notifications. |
request | Duration | The maximum duration, that a matchmaking ticket can remain in process before timing out. |
require | boolean | A 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:
IMatchmaking
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.
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.