class MatchmakingRuleSetBase
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.GameLift.Alpha.MatchmakingRuleSetBase |
![]() | github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#MatchmakingRuleSetBase |
![]() | software.amazon.awscdk.services.gamelift.alpha.MatchmakingRuleSetBase |
![]() | aws_cdk.aws_gamelift_alpha.MatchmakingRuleSetBase |
![]() | @aws-cdk/aws-gamelift-alpha ยป MatchmakingRuleSetBase |
Implements
IConstruct
, IDependable
, IResource
, IMatchmaking
Extends
Resource
Implemented by
Matchmaking
Base class for new and imported GameLift matchmaking ruleSet.
Initializer
new MatchmakingRuleSetBase(scope: Construct, id: string, props?: ResourceProps)
Parameters
- scope
Construct
- id
string
- props
Resource
Props
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
matchmaking | string | The ARN of the ruleSet. |
matchmaking | string | The unique name of the ruleSet. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
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
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
metric(metricName, props?) | Return the given named metric for this matchmaking ruleSet. |
metric | Rule evaluations during matchmaking that failed since the last report. |
metric | Rule evaluations during the matchmaking process that passed since the last report. |
to | Returns a string representation of this construct. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
Metric
Options
Returns
Return the given named metric for this matchmaking ruleSet.
metricRuleEvaluationsFailed(props?)
public metricRuleEvaluationsFailed(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
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
Metric
Options
Returns
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.