> **Experimental** > > `@aws-cdk/aws-gamelift-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump. # MatchmakingConfigurationBase Base class for new and imported GameLift Matchmaking configuration. Extends: Construct › Resource › MatchmakingConfigurationBase Implements: IMatchmakingConfiguration, IResource, IEnvironmentAware, IConstruct, IDependable Superclass of: QueuedMatchmakingConfiguration, StandaloneMatchmakingConfiguration - Stability: [Experimental](/cdk/api/stability.html) - Source: [`lib/matchmaking-configuration.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0-alpha.0/packages/@aws-cdk/aws-gamelift-alpha/lib/matchmaking-configuration.ts#L195) ## Example ```ts // 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 ```ts new MatchmakingConfigurationBase(scope: Construct, id: string, props?: ResourceProps) ``` ## Construct Props - `account`: string = the resource is in the same account as the stack it belongs to — The AWS account ID this resource belongs to. **Default:** the resource is in the same account as the stack it belongs to - `environmentFromArn`: string = take environment from `account`, `region` parameters, or use Stack environment. — ARN to deduce region and account from. The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources. Cannot be supplied together with either `account` or `region`. **Default:** take environment from `account`, `region` parameters, or use Stack environment. - `physicalName`: string = The physical name will be allocated by CloudFormation at deployment time — The value passed in by users to the physical name prop of the resource. - `undefined` implies that a physical name will be allocated by CloudFormation during deployment. - a concrete value implies a specific physical name - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation. **Default:** The physical name will be allocated by CloudFormation at deployment time - `region`: string = the resource is in the same region as the stack it belongs to — The AWS region this resource belongs to. **Default:** the resource is in the same region as the stack it belongs to ## Properties - `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — The environment this resource belongs to. 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. - `matchmakingConfigurationArn`: string (required) — The ARN of the matchmaking configuration. - `matchmakingConfigurationName`: string (required) — The Identifier of the matchmaking configuration. - `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node. - `notificationTarget`: [ITopic](/cdk/api/v2/docs/aws-cdk-lib.aws_sns.ITopic.html) — The notification target for matchmaking events. - `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined. ## Methods - `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource. When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default. **Parameters** - `strength` — - The reference strength to use for this resource. - `applyRemovalPolicy(policy: RemovalPolicy): void` — 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`). - `fromMatchmakingConfigurationAttributes(scope: Construct, id: string, attrs: MatchmakingConfigurationAttributes): IMatchmakingConfiguration` (static) — Import an existing matchmaking configuration from its attributes. - `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. **Parameters** - `x` — Any object. **Returns:** true if `x` is an object created from a class which extends `Construct`. - `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise. - `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource. - `metric(metricName: string, props?: MetricOptions): Metric` — Return the given named metric for this matchmaking configuration. - `metricCurrentTickets(props?: MetricOptions): Metric` — Matchmaking requests currently being processed or waiting to be processed. - `metricMatchesAccepted(props?: MetricOptions): Metric` — For matchmaking configurations that require acceptance, the potential matches that were accepted since the last report. - `metricMatchesCreated(props?: MetricOptions): Metric` — Potential matches that were created since the last report. - `metricMatchesPlaced(props?: MetricOptions): Metric` — Matches that were successfully placed into a game session since the last report. - `metricMatchesRejected(props?: MetricOptions): Metric` — For matchmaking configurations that require acceptance, the potential matches that were rejected by at least one player since the last report. - `metricPlayersStarted(props?: MetricOptions): Metric` — Players in matchmaking tickets that were added since the last report. - `metricTimeToMatch(props?: MetricOptions): 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(): string` — Returns a string representation of this construct. - `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. Use multiple `with()` calls if subsequent mixins should apply to added constructs.