@aws-cdk_aws-gamelift-alpha.MatchmakingRuleSet

class MatchmakingRuleSet (construct) ๐Ÿ”น

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

Implements IConstruct, IDependable, IResource, IMatchmakingRuleSet

Creates a new rule set for FlexMatch matchmaking.

The rule set determines the two key elements of a match: your game's team structure and size, and how to group players together for the best possible match.

For example, a rule set might describe a match like this:

  • Create a match with two teams of five players each, one team is the defenders and the other team the invaders.
  • A team can have novice and experienced players, but the average skill of the two teams must be within 10 points of each other.
  • If no match is made after 30 seconds, gradually relax the skill requirements.

Rule sets must be defined in the same Region as the matchmaking configuration they are used with.

See also: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html

Example

new gamelift.MatchmakingRuleSet(this, 'RuleSet', {
  matchmakingRuleSetName: 'my-test-ruleset',
  content: gamelift.RuleSetContent.fromJsonFile(path.join(__dirname, 'my-ruleset/ruleset.json')),
});

Initializer

new MatchmakingRuleSet(scope: Construct, id: string, props: MatchmakingRuleSetProps)

Parameters

  • scope Construct
  • id string
  • props MatchmakingRuleSetProps

Construct Props

NameTypeDescription
content๐Ÿ”นRuleSetContentA collection of matchmaking rules.
matchmakingRuleSetName๐Ÿ”นstringA unique identifier for the matchmaking rule set.

content๐Ÿ”น

Type: RuleSetContent

A collection of matchmaking rules.


matchmakingRuleSetName๐Ÿ”น

Type: string

A unique identifier for the matchmaking rule set.

A matchmaking configuration identifies the rule set it uses by this name value.

Note: the rule set name is different from the optional name field in the rule set body

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.
toString()๐Ÿ”นReturns a string representation of this construct.
static fromMatchmakingRuleSetArn(scope, id, matchmakingRuleSetArn)๐Ÿ”นImport a ruleSet into CDK using its ARN.
static fromMatchmakingRuleSetAttributes(scope, id, attrs)๐Ÿ”นImport an existing matchmaking ruleSet from its attributes.
static fromMatchmakingRuleSetName(scope, id, matchmakingRuleSetName)๐Ÿ”นImport a ruleSet into CDK using its name.

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.


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromMatchmakingRuleSetArn(scope, id, matchmakingRuleSetArn)๐Ÿ”น

public static fromMatchmakingRuleSetArn(scope: Construct, id: string, matchmakingRuleSetArn: string): IMatchmakingRuleSet

Parameters

  • scope Construct
  • id string
  • matchmakingRuleSetArn string

Returns

  • IMatchmakingRuleSet

Import a ruleSet into CDK using its ARN.


static fromMatchmakingRuleSetAttributes(scope, id, attrs)๐Ÿ”น

public static fromMatchmakingRuleSetAttributes(scope: Construct, id: string, attrs: MatchmakingRuleSetAttributes): IMatchmakingRuleSet

Parameters

  • scope Construct
  • id string
  • attrs MatchmakingRuleSetAttributes

Returns

  • IMatchmakingRuleSet

Import an existing matchmaking ruleSet from its attributes.


static fromMatchmakingRuleSetName(scope, id, matchmakingRuleSetName)๐Ÿ”น

public static fromMatchmakingRuleSetName(scope: Construct, id: string, matchmakingRuleSetName: string): IMatchmakingRuleSet

Parameters

  • scope Construct
  • id string
  • matchmakingRuleSetName string

Returns

  • IMatchmakingRuleSet

Import a ruleSet into CDK using its name.