Class MatchmakingConfigurationBase

(experimental) Base class for new and imported GameLift Matchmaking configuration.

Inheritance

object

Resource

MatchmakingConfigurationBase

QueuedMatchmakingConfiguration

StandaloneMatchmakingConfiguration

Implements

IMatchmakingConfiguration

IResource

IConstruct

IDependable

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.GameLift.Alpha

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

Syntax (csharp)

public abstract class MatchmakingConfigurationBase : Resource, IMatchmakingConfiguration, IResource, IConstruct, IDependable

Syntax (vb)

Public MustInherit Class MatchmakingConfigurationBase Inherits Resource Implements IMatchmakingConfiguration, IResource, IConstruct, IDependable

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.AWS.SNS;

             Topic topic;

             var matchmakingConfigurationBase = MatchmakingConfigurationBase.FromMatchmakingConfigurationAttributes(this, "MyMatchmakingConfigurationBase", new MatchmakingConfigurationAttributes {
                 MatchmakingConfigurationArn = "matchmakingConfigurationArn",
                 MatchmakingConfigurationName = "matchmakingConfigurationName",
                 NotificationTarget = topic
             });

Synopsis

Constructors

MatchmakingConfigurationBase(Construct, string, IResourceProps?)

(experimental) Base class for new and imported GameLift Matchmaking configuration.

Properties

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

Methods

FromMatchmakingConfigurationAttributes(Construct, string, IMatchmakingConfigurationAttributes)	(experimental) Import an existing matchmaking configuration from its attributes.
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.

Constructors

MatchmakingConfigurationBase(Construct, string, IResourceProps?)

(experimental) Base class for new and imported GameLift Matchmaking configuration.

protected MatchmakingConfigurationBase(Construct scope, string id, IResourceProps? props = null)

Parameters

scope Construct

id string

props IResourceProps

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.AWS.SNS;

             Topic topic;

             var matchmakingConfigurationBase = MatchmakingConfigurationBase.FromMatchmakingConfigurationAttributes(this, "MyMatchmakingConfigurationBase", new MatchmakingConfigurationAttributes {
                 MatchmakingConfigurationArn = "matchmakingConfigurationArn",
                 MatchmakingConfigurationName = "matchmakingConfigurationName",
                 NotificationTarget = topic
             });

Properties

MatchmakingConfigurationArn

(experimental) The ARN of the matchmaking configuration.

public abstract string MatchmakingConfigurationArn { get; }

Property Value

string

Remarks

Stability: Experimental

MatchmakingConfigurationName

(experimental) The Identifier of the matchmaking configuration.

public abstract string MatchmakingConfigurationName { get; }

Property Value

string

Remarks

Stability: Experimental

NotificationTarget

(experimental) The notification target for matchmaking events.

public abstract ITopic? NotificationTarget { get; }

Property Value

ITopic

Remarks

Stability: Experimental

Methods

FromMatchmakingConfigurationAttributes(Construct, string, IMatchmakingConfigurationAttributes)

(experimental) Import an existing matchmaking configuration from its attributes.

public static IMatchmakingConfiguration FromMatchmakingConfigurationAttributes(Construct scope, string id, IMatchmakingConfigurationAttributes attrs)

Parameters

scope Construct

id string

attrs IMatchmakingConfigurationAttributes

Returns

IMatchmakingConfiguration

Remarks

Stability: Experimental

Metric(string, IMetricOptions?)

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

public virtual 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.

public virtual 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.

public virtual 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.

public virtual 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.

public virtual 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.

public virtual 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.

public virtual 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.

public virtual Metric MetricTimeToMatch(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Units: seconds

Stability: Experimental

Implements

IMatchmakingConfiguration

IResource

Constructs.IConstruct

Constructs.IDependable