AWS CDK Reference

Appearance

v2.274.0

Experimental

@aws-cdk/aws-gamelift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

IMatchmakingRuleSet Interface ​

Represents a Gamelift matchmaking ruleset.

Stability
Experimental
Source
lib/matchmaking-ruleset.ts

Properties ​

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#
The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

matchmakingRuleSetArnstringmatchmaking_rule_set_arnstrmatchmakingRuleSetArnStringMatchmakingRuleSetArnstringMatchmakingRuleSetArn*stringrequired#
The ARN of the ruleSet.
matchmakingRuleSetNamestringmatchmaking_rule_set_namestrmatchmakingRuleSetNameStringMatchmakingRuleSetNamestringMatchmakingRuleSetName*stringrequired#
The unique name of the ruleSet.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.

Methods ​

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

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: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metric#
Return the given named metric for this matchmaking ruleSet.
metricRuleEvaluationsFailed(props?: MetricOptions): Metricdef metric_rule_evaluations_failed(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricRuleEvaluationsFailed(MetricOptions props)public Metric MetricRuleEvaluationsFailed(MetricOptions? props = null)func MetricRuleEvaluationsFailed(Props MetricOptions) Metric#
Rule evaluations during matchmaking that failed since the last report.

This metric is limited to the top 50 rules.

metricRuleEvaluationsPassed(props?: MetricOptions): Metricdef metric_rule_evaluations_passed(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricRuleEvaluationsPassed(MetricOptions props)public Metric MetricRuleEvaluationsPassed(MetricOptions? props = null)func MetricRuleEvaluationsPassed(Props MetricOptions) Metric#
Rule evaluations during the matchmaking process that passed since the last report.

This metric is limited to the top 50 rules.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining