Experimental
@aws-cdk/aws-gamelift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
MatchmakingConfigurationProps Struct
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,
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_gamelift_alpha as gamelift_alpha
import aws_cdk as cdk
from aws_cdk import aws_sns as sns
# matchmaking_rule_set: gamelift_alpha.MatchmakingRuleSet
# topic: sns.Topic
matchmaking_configuration_props = gamelift_alpha.MatchmakingConfigurationProps(
matchmaking_configuration_name="matchmakingConfigurationName",
rule_set=matchmaking_rule_set,
# the properties below are optional
acceptance_timeout=cdk.Duration.minutes(30),
custom_event_data="customEventData",
description="description",
notification_target=topic,
request_timeout=cdk.Duration.minutes(30),
require_acceptance=False
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.gamelift.alpha.*;
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.sns.*;
MatchmakingRuleSet matchmakingRuleSet;
Topic topic;
MatchmakingConfigurationProps matchmakingConfigurationProps = MatchmakingConfigurationProps.builder()
.matchmakingConfigurationName("matchmakingConfigurationName")
.ruleSet(matchmakingRuleSet)
// the properties below are optional
.acceptanceTimeout(Duration.minutes(30))
.customEventData("customEventData")
.description("description")
.notificationTarget(topic)
.requestTimeout(Duration.minutes(30))
.requireAcceptance(false)
.build();
// Install: dotnet add package Amazon.CDK.AWS.GameLift.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift.Alpha;
using Amazon.CDK;
using Amazon.CDK.AWS.SNS;
MatchmakingRuleSet matchmakingRuleSet;
Topic topic;
var matchmakingConfigurationProps = new MatchmakingConfigurationProps {
MatchmakingConfigurationName = "matchmakingConfigurationName",
RuleSet = matchmakingRuleSet,
// the properties below are optional
AcceptanceTimeout = Duration.Minutes(30),
CustomEventData = "customEventData",
Description = "description",
NotificationTarget = topic,
RequestTimeout = Duration.Minutes(30),
RequireAcceptance = false
};
// Install: go get github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import gamelift_alpha "github.com/aws/aws-cdk-go/awscdkgameliftalpha"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var matchmakingRuleSet MatchmakingRuleSet
var topic Topic
matchmakingConfigurationProps := &MatchmakingConfigurationProps{
MatchmakingConfigurationName: jsii.String("matchmakingConfigurationName"),
RuleSet: matchmakingRuleSet,
// the properties below are optional
AcceptanceTimeout: cdk.Duration_Minutes(jsii.Number(30)),
CustomEventData: jsii.String("customEventData"),
Description: jsii.String("description"),
NotificationTarget: topic,
RequestTimeout: cdk.Duration_*Minutes(jsii.Number(30)),
RequireAcceptance: jsii.Boolean(false),
}
Properties
acceptanceTimeoutoptionalDurationacceptance_timeoutoptionalDurationacceptanceTimeoutoptionalDurationAcceptanceTimeoutoptionalDurationAcceptanceTimeoutoptionalDuration#Default: 300 seconds
customEventDataoptionalstringcustom_event_dataoptionalstrcustomEventDataoptionalStringCustomEventDataoptionalstringCustomEventDataoptional*string#Default: no custom data added to events
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Default: no description is provided
matchmakingConfigurationNamestringmatchmaking_configuration_namestrmatchmakingConfigurationNameStringMatchmakingConfigurationNamestringMatchmakingConfigurationName*stringrequired#This name is used to identify the configuration associated with a matchmaking request or ticket.
notificationTargetoptionalITopicnotification_targetoptionalITopicnotificationTargetoptionalITopicNotificationTargetoptionalITopicNotificationTargetoptionalITopic#Default: no notification target
requestTimeoutoptionalDurationrequest_timeoutoptionalDurationrequestTimeoutoptionalDurationRequestTimeoutoptionalDurationRequestTimeoutoptionalDuration#Default: 300 seconds
Requests that fail due to timing out can be resubmitted as needed.
requireAcceptanceoptionalbooleanrequire_acceptanceoptionalboolrequireAcceptanceoptionalBooleanRequireAcceptanceoptionalboolRequireAcceptanceoptional*bool#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 configuration can only use rule sets that are defined in the same Region.