Package software.amazon.awscdk.services.gamelift.alpha

Class MatchmakingRuleSetBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.gamelift.alpha.MatchmakingRuleSetBase

All Implemented Interfaces:

IResource, IMatchmakingRuleSet, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

MatchmakingRuleSet

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:25.771Z")
@Stability(Experimental)
public abstract class MatchmakingRuleSetBase
extends Resource
implements IMatchmakingRuleSet

(experimental) Base class for new and imported GameLift matchmaking ruleSet.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.alpha.IMatchmakingRuleSet

IMatchmakingRuleSet.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MatchmakingRuleSetBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	MatchmakingRuleSetBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	MatchmakingRuleSetBase(software.constructs.Construct scope, String id)
protected	MatchmakingRuleSetBase(software.constructs.Construct scope, String id, ResourceProps props)

Method Summary

Modifier and Type	Method	Description
abstract String	getMatchmakingRuleSetArn()	(experimental) The ARN of the ruleSet.
abstract String	getMatchmakingRuleSetName()	(experimental) The unique name of the ruleSet.
Metric	metric(String metricName)	(experimental) Return the given named metric for this matchmaking ruleSet.
Metric	metric(String metricName, MetricOptions props)	(experimental) Return the given named metric for this matchmaking ruleSet.
Metric	metricRuleEvaluationsFailed()	(experimental) Rule evaluations during matchmaking that failed since the last report.
Metric	metricRuleEvaluationsFailed(MetricOptions props)	(experimental) Rule evaluations during matchmaking that failed since the last report.
Metric	metricRuleEvaluationsPassed()	(experimental) Rule evaluations during the matchmaking process that passed since the last report.
Metric	metricRuleEvaluationsPassed(MetricOptions props)	(experimental) Rule evaluations during the matchmaking process that passed since the last report.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

MatchmakingRuleSetBase

protected MatchmakingRuleSetBase(software.amazon.jsii.JsiiObjectRef objRef)

MatchmakingRuleSetBase

protected MatchmakingRuleSetBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

MatchmakingRuleSetBase

@Stability(Stable)
protected MatchmakingRuleSetBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

MatchmakingRuleSetBase

@Stability(Stable)
protected MatchmakingRuleSetBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

metric

@Stability(Experimental)
@NotNull
public Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

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

Specified by:

metric in interface IMatchmakingRuleSet

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(Experimental)
@NotNull
public Metric metric(@NotNull
 String metricName)

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

Specified by:

metric in interface IMatchmakingRuleSet

Parameters:

metricName - This parameter is required.

metricRuleEvaluationsFailed

@Stability(Experimental)
@NotNull
public Metric metricRuleEvaluationsFailed(@Nullable
 MetricOptions props)

(experimental) Rule evaluations during matchmaking that failed since the last report.

This metric is limited to the top 50 rules.

Specified by:

metricRuleEvaluationsFailed in interface IMatchmakingRuleSet

Parameters:

props -

metricRuleEvaluationsFailed

@Stability(Experimental)
@NotNull
public Metric metricRuleEvaluationsFailed()

(experimental) Rule evaluations during matchmaking that failed since the last report.

This metric is limited to the top 50 rules.

Specified by:

metricRuleEvaluationsFailed in interface IMatchmakingRuleSet

metricRuleEvaluationsPassed

@Stability(Experimental)
@NotNull
public Metric metricRuleEvaluationsPassed(@Nullable
 MetricOptions props)

(experimental) Rule evaluations during the matchmaking process that passed since the last report.

This metric is limited to the top 50 rules.

Specified by:

metricRuleEvaluationsPassed in interface IMatchmakingRuleSet

Parameters:

props -

metricRuleEvaluationsPassed

@Stability(Experimental)
@NotNull
public Metric metricRuleEvaluationsPassed()

(experimental) Rule evaluations during the matchmaking process that passed since the last report.

This metric is limited to the top 50 rules.

Specified by:

metricRuleEvaluationsPassed in interface IMatchmakingRuleSet

getMatchmakingRuleSetArn

@Stability(Experimental)
@NotNull
public abstract String getMatchmakingRuleSetArn()

(experimental) The ARN of the ruleSet.

Specified by:

getMatchmakingRuleSetArn in interface IMatchmakingRuleSet

getMatchmakingRuleSetName

@Stability(Experimental)
@NotNull
public abstract String getMatchmakingRuleSetName()

(experimental) The unique name of the ruleSet.

Specified by:

getMatchmakingRuleSetName in interface IMatchmakingRuleSet