Interface IMatchmakingConfiguration

(experimental) Represents a Gamelift matchmaking configuration.

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Stack

IEnvironmentAware.Env

Namespace: Amazon.CDK.AWS.GameLift.Alpha

Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll

Syntax (csharp)

public interface IMatchmakingConfiguration : IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Interface IMatchmakingConfiguration Inherits IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

Stability: Experimental

Synopsis

Properties

MatchmakingConfigurationArn	(experimental) The ARN of the matchmaking configuration.
MatchmakingConfigurationName	(experimental) The name of the matchmaking configuration.
NotificationTarget	(experimental) The notification target for matchmaking events.

Methods

Metric(string, IMetricOptions?)	(experimental) Return the given named metric for this matchmaking configuration.
MetricCurrentTickets(IMetricOptions?)	(experimental) Matchmaking requests currently being processed or waiting to be processed.
MetricMatchesAccepted(IMetricOptions?)	(experimental) For matchmaking configurations that require acceptance, the potential matches that were accepted since the last report.
MetricMatchesCreated(IMetricOptions?)	(experimental) Potential matches that were created since the last report.
MetricMatchesPlaced(IMetricOptions?)	(experimental) Matches that were successfully placed into a game session since the last report.
MetricMatchesRejected(IMetricOptions?)	(experimental) For matchmaking configurations that require acceptance, the potential matches that were rejected by at least one player since the last report.
MetricPlayersStarted(IMetricOptions?)	(experimental) Players in matchmaking tickets that were added since the last report.
MetricTimeToMatch(IMetricOptions?)	(experimental) For matchmaking requests that were put into a potential match before the last report, the amount of time between ticket creation and potential match creation.

Properties

MatchmakingConfigurationArn

(experimental) The ARN of the matchmaking configuration.

string MatchmakingConfigurationArn { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

MatchmakingConfigurationName

(experimental) The name of the matchmaking configuration.

string MatchmakingConfigurationName { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

NotificationTarget

(experimental) The notification target for matchmaking events.

ITopic? NotificationTarget { get; }

Property Value

ITopic

Remarks

Stability: Experimental

Attribute: true

Methods

Metric(string, IMetricOptions?)

(experimental) Return the given named metric for this matchmaking configuration.

Metric Metric(string metricName, IMetricOptions? props = null)

Parameters

metricName string

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricCurrentTickets(IMetricOptions?)

(experimental) Matchmaking requests currently being processed or waiting to be processed.

Metric MetricCurrentTickets(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricMatchesAccepted(IMetricOptions?)

(experimental) For matchmaking configurations that require acceptance, the potential matches that were accepted since the last report.

Metric MetricMatchesAccepted(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricMatchesCreated(IMetricOptions?)

(experimental) Potential matches that were created since the last report.

Metric MetricMatchesCreated(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricMatchesPlaced(IMetricOptions?)

(experimental) Matches that were successfully placed into a game session since the last report.

Metric MetricMatchesPlaced(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricMatchesRejected(IMetricOptions?)

(experimental) For matchmaking configurations that require acceptance, the potential matches that were rejected by at least one player since the last report.

Metric MetricMatchesRejected(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricPlayersStarted(IMetricOptions?)

(experimental) Players in matchmaking tickets that were added since the last report.

Metric MetricPlayersStarted(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricTimeToMatch(IMetricOptions?)

(experimental) For matchmaking requests that were put into a potential match before the last report, the amount of time between ticket creation and potential match creation.

Metric MetricTimeToMatch(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Units: seconds

Stability: Experimental