@aws-cdk_aws-gamelift-alpha.IMatchmakingRuleSet

interface IMatchmakingRuleSet ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.GameLift.Alpha.IMatchmakingRuleSet
Gogithub.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#IMatchmakingRuleSet
Javasoftware.amazon.awscdk.services.gamelift.alpha.IMatchmakingRuleSet
Pythonaws_cdk.aws_gamelift_alpha.IMatchmakingRuleSet
TypeScript (source)@aws-cdk/aws-gamelift-alpha ยป IMatchmakingRuleSet

Implemented by MatchmakingRuleSet

Obtainable from MatchmakingRuleSet.fromMatchmakingRuleSetArn(), MatchmakingRuleSet.fromMatchmakingRuleSetAttributes(), MatchmakingRuleSet.fromMatchmakingRuleSetName()

Represents a Gamelift matchmaking ruleset.

Properties

NameTypeDescription
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
matchmakingRuleSetArn๐Ÿ”นstringThe ARN of the ruleSet.
matchmakingRuleSetName๐Ÿ”นstringThe unique name of the ruleSet.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.

env๐Ÿ”น

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


matchmakingRuleSetArn๐Ÿ”น

Type: string

The ARN of the ruleSet.


matchmakingRuleSetName๐Ÿ”น

Type: string

The unique name of the ruleSet.


node๐Ÿ”น

Type: Node

The tree node.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
metric(metricName, props?)๐Ÿ”นReturn the given named metric for this matchmaking ruleSet.
metricRuleEvaluationsFailed(props?)๐Ÿ”นRule evaluations during matchmaking that failed since the last report.
metricRuleEvaluationsPassed(props?)๐Ÿ”นRule evaluations during the matchmaking process that passed since the last report.

applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


metric(metricName, props?)๐Ÿ”น

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

  • metricName string
  • props MetricOptions

Returns

  • Metric

Return the given named metric for this matchmaking ruleSet.


metricRuleEvaluationsFailed(props?)๐Ÿ”น

public metricRuleEvaluationsFailed(props?: MetricOptions): Metric

Parameters

  • props MetricOptions

Returns

  • Metric

Rule evaluations during matchmaking that failed since the last report.

This metric is limited to the top 50 rules.


metricRuleEvaluationsPassed(props?)๐Ÿ”น

public metricRuleEvaluationsPassed(props?: MetricOptions): Metric

Parameters

  • props MetricOptions

Returns

  • Metric

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

This metric is limited to the top 50 rules.