class MatchmakingConfigurationBase 🔹

Language	Type name
.NET	Amazon.CDK.AWS.GameLift.Alpha.MatchmakingConfigurationBase
Go	github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#MatchmakingConfigurationBase
Java	software.amazon.awscdk.services.gamelift.alpha.MatchmakingConfigurationBase
Python	aws_cdk.aws_gamelift_alpha.MatchmakingConfigurationBase
TypeScript (source)	@aws-cdk/aws-gamelift-alpha » MatchmakingConfigurationBase

Implements IConstruct, IDependable, IResource, IMatchmakingConfiguration

Extends Resource

Implemented by QueuedMatchmakingConfiguration, StandaloneMatchmakingConfiguration

Base class for new and imported GameLift Matchmaking configuration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';
import { aws_sns as sns } from 'aws-cdk-lib';

declare const topic: sns.Topic;
const matchmakingConfigurationBase = gamelift_alpha.MatchmakingConfigurationBase.fromMatchmakingConfigurationAttributes(this, 'MyMatchmakingConfigurationBase', {
  matchmakingConfigurationArn: 'matchmakingConfigurationArn',
  matchmakingConfigurationName: 'matchmakingConfigurationName',
  notificationTarget: topic,
});

Initializer

new MatchmakingConfigurationBase(scope: Construct, id: string, props?: ResourceProps)

Parameters

• scope Construct
• id string
• props ResourceProps

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
matchmakingConfigurationArn🔹	string	The ARN of the matchmaking configuration.
matchmakingConfigurationName🔹	string	The Identifier of the matchmaking configuration.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
notificationTarget?🔹	ITopic	The notification target for matchmaking events.

---

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.

---

matchmakingConfigurationArn🔹

Type: string

The ARN of the matchmaking configuration.

---

matchmakingConfigurationName🔹

Type: string

The Identifier of the matchmaking configuration.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

notificationTarget?🔹

Type: ITopic (optional)

The notification target for matchmaking events.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
metric(metricName, props?)🔹	Return the given named metric for this matchmaking configuration.
metricCurrentTickets(props?)🔹	Matchmaking requests currently being processed or waiting to be processed.
metricMatchesAccepted(props?)🔹	For matchmaking configurations that require acceptance, the potential matches that were accepted since the last report.
metricMatchesCreated(props?)🔹	Potential matches that were created since the last report.
metricMatchesPlaced(props?)🔹	Matches that were successfully placed into a game session since the last report.
metricMatchesRejected(props?)🔹	For matchmaking configurations that require acceptance, the potential matches that were rejected by at least one player since the last report.
metricPlayersStarted(props?)🔹	Players in matchmaking tickets that were added since the last report.
metricTimeToMatch(props?)🔹	For matchmaking requests that were put into a potential match before the last report, the amount of time between ticket creation and potential match creation.
toString()🔹	Returns a string representation of this construct.
static fromMatchmakingConfigurationAttributes(scope, id, attrs)🔹	Import an existing matchmaking configuration from its attributes.

---

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 configuration.

---

metricCurrentTickets(props?)🔹

public metricCurrentTickets(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Matchmaking requests currently being processed or waiting to be processed.

---

metricMatchesAccepted(props?)🔹

public metricMatchesAccepted(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

For matchmaking configurations that require acceptance, the potential matches that were accepted since the last report.

---

metricMatchesCreated(props?)🔹

public metricMatchesCreated(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Potential matches that were created since the last report.

---

metricMatchesPlaced(props?)🔹

public metricMatchesPlaced(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Matches that were successfully placed into a game session since the last report.

---

metricMatchesRejected(props?)🔹

public metricMatchesRejected(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

For matchmaking configurations that require acceptance, the potential matches that were rejected by at least one player since the last report.

---

metricPlayersStarted(props?)🔹

public metricPlayersStarted(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Players in matchmaking tickets that were added since the last report.

---

metricTimeToMatch(props?)🔹

public metricTimeToMatch(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

For matchmaking requests that were put into a potential match before the last report, the amount of time between ticket creation and potential match creation.

Units: seconds

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromMatchmakingConfigurationAttributes(scope, id, attrs)🔹

public static fromMatchmakingConfigurationAttributes(scope: Construct, id: string, attrs: MatchmakingConfigurationAttributes): IMatchmakingConfiguration

Parameters

• scope Construct
• id string
• attrs MatchmakingConfigurationAttributes

Returns

• IMatchmakingConfiguration

Import an existing matchmaking configuration from its attributes.