Class StandaloneMatchmakingConfigurationProps
(experimental) Properties for a new standalone matchmaking configuration.
Inheritance
Namespace: Amazon.CDK.AWS.GameLift.Alpha
Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll
Syntax (csharp)
public class StandaloneMatchmakingConfigurationProps : Object, IStandaloneMatchmakingConfigurationProps, IMatchmakingConfigurationProps
Syntax (vb)
Public Class StandaloneMatchmakingConfigurationProps
Inherits Object
Implements IStandaloneMatchmakingConfigurationProps, IMatchmakingConfigurationProps
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
MatchmakingRuleSet ruleSet;
new StandaloneMatchmakingConfiguration(this, "StandaloneMatchmaking", new StandaloneMatchmakingConfigurationProps {
MatchmakingConfigurationName = "test-standalone-config-name",
RuleSet = ruleSet
});
Synopsis
Constructors
StandaloneMatchmakingConfigurationProps() |
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. |
Constructors
StandaloneMatchmakingConfigurationProps()
public StandaloneMatchmakingConfigurationProps()
Properties
AcceptanceTimeout
(experimental) The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
public Duration AcceptanceTimeout { get; set; }
Property Value
Remarks
Default: 300 seconds
Stability: Experimental
CustomEventData
(experimental) Information to add to all events related to the matchmaking configuration.
public string CustomEventData { get; set; }
Property Value
System.String
Remarks
Default: no custom data added to events
Stability: Experimental
Description
(experimental) A human-readable description of the matchmaking configuration.
public string Description { get; set; }
Property Value
System.String
Remarks
Default: no description is provided
Stability: Experimental
MatchmakingConfigurationName
(experimental) A unique identifier for the matchmaking configuration.
public string MatchmakingConfigurationName { get; set; }
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.
public ITopic NotificationTarget { get; set; }
Property Value
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.
public Duration RequestTimeout { get; set; }
Property Value
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.
public Nullable<bool> RequireAcceptance { get; set; }
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.
public IMatchmakingRuleSet RuleSet { get; set; }
Property Value
Remarks
A matchmaking configuration can only use rule sets that are defined in the same Region.
Stability: Experimental