AWS CDK Reference

Appearance

v2.273.0

Experimental

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

MatchmakingConfigurationBase L2 construct ​

Base class for new and imported GameLift Matchmaking configuration.

Stability
Experimental
Source
lib/matchmaking-configuration.ts

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)
python
MatchmakingConfigurationBase(scope: Construct, id: str, props: typing.Optional[ResourceProps] = None)
java
new MatchmakingConfigurationBase(Construct scope, String id, ResourceProps props)
csharp
new MatchmakingConfigurationBase(Construct scope, string id, ResourceProps? props = null)
go
NewMatchmakingConfigurationBase(Scope Construct, Id *string, Props ResourceProps)

Construct Props ​

accountstringaccountstraccountStringAccountstringAccount*string= the resource is in the same acco…#
The AWS account ID this resource belongs to.
default

Default: the resource is in the same account as the stack it belongs to

environmentFromArnstringenvironment_from_arnstrenvironmentFromArnStringEnvironmentFromArnstringEnvironmentFromArn*string= take environment from `account`,…#
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

Default: take environment from account, region parameters, or use Stack environment.

physicalNamestringphysical_namestrphysicalNameStringPhysicalNamestringPhysicalName*string= The physical name will be alloca…#
The value passed in by users to the physical name prop of the resource.
notes · default
  • 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

regionstringregionstrregionStringRegionstringRegion*string= the resource is in the same regi…#
The AWS region this resource belongs to.
default

Default: the resource is in the same region as the stack it belongs to

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.

matchmakingConfigurationArnstringmatchmaking_configuration_arnstrmatchmakingConfigurationArnStringMatchmakingConfigurationArnstringMatchmakingConfigurationArn*stringrequired#
The ARN of the matchmaking configuration.
matchmakingConfigurationNamestringmatchmaking_configuration_namestrmatchmakingConfigurationNameStringMatchmakingConfigurationNamestringMatchmakingConfigurationName*stringrequired#
The Identifier of the matchmaking configuration.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
notificationTargetITopicnotification_targetITopicnotificationTargetITopicNotificationTargetITopicNotificationTargetITopic#
The notification target for matchmaking events.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.

Methods ​

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#
Override the cross-stack reference strength for this resource.
notes · 1 parameter

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

  • strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.
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).

fromMatchmakingConfigurationAttributes(scope: Construct, id: string, attrs: MatchmakingConfigurationAttributes): IMatchmakingConfiguration@staticmethod def from_matchmaking_configuration_attributes(scope: Construct, id: str, attrs: MatchmakingConfigurationAttributes) -> IMatchmakingConfigurationpublic static IMatchmakingConfiguration fromMatchmakingConfigurationAttributes(Construct scope, String id, MatchmakingConfigurationAttributes attrs)public static IMatchmakingConfiguration FromMatchmakingConfigurationAttributes(Construct scope, string id, MatchmakingConfigurationAttributes attrs)func FromMatchmakingConfigurationAttributes(Scope Construct, Id *string, Attrs MatchmakingConfigurationAttributes) IMatchmakingConfigurationstatic#
Import an existing matchmaking configuration from its attributes.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

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

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#
Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#
Check whether the given construct is a Resource.
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 configuration.
metricCurrentTickets(props?: MetricOptions): Metricdef metric_current_tickets(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricCurrentTickets(MetricOptions props)public Metric MetricCurrentTickets(MetricOptions? props = null)func MetricCurrentTickets(Props MetricOptions) Metric#
Matchmaking requests currently being processed or waiting to be processed.
metricMatchesAccepted(props?: MetricOptions): Metricdef metric_matches_accepted(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricMatchesAccepted(MetricOptions props)public Metric MetricMatchesAccepted(MetricOptions? props = null)func MetricMatchesAccepted(Props MetricOptions) Metric#
For matchmaking configurations that require acceptance, the potential matches that were accepted since the last report.
metricMatchesCreated(props?: MetricOptions): Metricdef metric_matches_created(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricMatchesCreated(MetricOptions props)public Metric MetricMatchesCreated(MetricOptions? props = null)func MetricMatchesCreated(Props MetricOptions) Metric#
Potential matches that were created since the last report.
metricMatchesPlaced(props?: MetricOptions): Metricdef metric_matches_placed(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricMatchesPlaced(MetricOptions props)public Metric MetricMatchesPlaced(MetricOptions? props = null)func MetricMatchesPlaced(Props MetricOptions) Metric#
Matches that were successfully placed into a game session since the last report.
metricMatchesRejected(props?: MetricOptions): Metricdef metric_matches_rejected(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricMatchesRejected(MetricOptions props)public Metric MetricMatchesRejected(MetricOptions? props = null)func 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): Metricdef metric_players_started(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricPlayersStarted(MetricOptions props)public Metric MetricPlayersStarted(MetricOptions? props = null)func MetricPlayersStarted(Props MetricOptions) Metric#
Players in matchmaking tickets that were added since the last report.
metricTimeToMatch(props?: MetricOptions): Metricdef metric_time_to_match(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricTimeToMatch(MetricOptions props)public Metric MetricTimeToMatch(MetricOptions? props = null)func 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(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
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. Use multiple with() calls if subsequent mixins should apply to added constructs.