@aws-cdk/aws-gamelift-alpha.MatchmakingConfigurationProps

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.

Stability

Experimental

Source

lib/matchmaking-configuration.ts

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

acceptanceTimeout?optionalDurationacceptance_timeout?optionalDurationacceptanceTimeout?optionalDurationAcceptanceTimeout?optionalDurationAcceptanceTimeout?optionalDuration#

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

Default: 300 seconds

customEventData?optionalstringcustom_event_data?optionalstrcustomEventData?optionalStringCustomEventData?optionalstringCustomEventData?optional*string#

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

Default: no custom data added to events

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*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.

notificationTarget?optionalITopicnotification_target?optionalITopicnotificationTarget?optionalITopicNotificationTarget?optionalITopicNotificationTarget?optionalITopic#

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

Default: no notification target

requestTimeout?optionalDurationrequest_timeout?optionalDurationrequestTimeout?optionalDurationRequestTimeout?optionalDurationRequestTimeout?optionalDuration#

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.

requireAcceptance?optionalbooleanrequire_acceptance?optionalboolrequireAcceptance?optionalBooleanRequireAcceptance?optionalboolRequireAcceptance?optional*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.

ruleSetIMatchmakingRuleSetrule_setIMatchmakingRuleSetruleSetIMatchmakingRuleSetRuleSetIMatchmakingRuleSetRuleSetIMatchmakingRuleSetrequired#

A matchmaking rule set to use with this configuration.

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