Interface IMatchmakingConfigurationProps

(experimental) Properties for a new Gamelift matchmaking configuration.

Namespace: Amazon.CDK.AWS.GameLift.Alpha
Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll
Syntax (csharp)
public interface IMatchmakingConfigurationProps
Syntax (vb)
Public Interface IMatchmakingConfigurationProps
Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples
// 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
};

Synopsis

Properties

AcceptanceTimeout

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

(experimental) Information to add to all events related to the matchmaking configuration.
Description

(experimental) A human-readable description of the matchmaking configuration.
MatchmakingConfigurationName

(experimental) A unique identifier for the matchmaking configuration.
NotificationTarget

(experimental) An SNS topic ARN that is set up to receive matchmaking notifications.
RequestTimeout

(experimental) The maximum duration, that a matchmaking ticket can remain in process before timing out.
RequireAcceptance

(experimental) A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
RuleSet

(experimental) A matchmaking rule set to use with this configuration.

Properties

AcceptanceTimeout

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

virtual Duration AcceptanceTimeout { get; }
Property Value

Duration

Remarks

Default: 300 seconds

Stability: Experimental

CustomEventData

(experimental) Information to add to all events related to the matchmaking configuration.

virtual string CustomEventData { get; }
Property Value

System.String

Remarks

Default: no custom data added to events

Stability: Experimental

Description

(experimental) A human-readable description of the matchmaking configuration.

virtual string Description { get; }
Property Value

System.String

Remarks

Default: no description is provided

Stability: Experimental

MatchmakingConfigurationName

(experimental) A unique identifier for the matchmaking configuration.

string MatchmakingConfigurationName { get; }
Property Value

System.String

Remarks

This name is used to identify the configuration associated with a matchmaking request or ticket.

Stability: Experimental

NotificationTarget

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

virtual ITopic NotificationTarget { get; }
Property Value

ITopic

Remarks

Default: no notification target

Stability: Experimental

See: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html

RequestTimeout

(experimental) The maximum duration, that a matchmaking ticket can remain in process before timing out.

virtual Duration RequestTimeout { get; }
Property Value

Duration

Remarks

Requests that fail due to timing out can be resubmitted as needed.

Default: 300 seconds

Stability: Experimental

RequireAcceptance

(experimental) A flag that determines whether a match that was created with this configuration must be accepted by the matched players.

virtual Nullable<bool> RequireAcceptance { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

Default: Acceptance is not required

Stability: Experimental

RuleSet

(experimental) A matchmaking rule set to use with this configuration.

IMatchmakingRuleSet RuleSet { get; }
Property Value

IMatchmakingRuleSet

Remarks

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

Stability: Experimental