class CfnMatchmakingConfiguration (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.GameLift.CfnMatchmakingConfiguration`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnMatchmakingConfiguration`
Java	`software.amazon.awscdk.services.gamelift.CfnMatchmakingConfiguration`
Python	`aws_cdk.aws_gamelift.CfnMatchmakingConfiguration`
TypeScript	`aws-cdk-lib` » `aws_gamelift` » `CfnMatchmakingConfiguration`

Implements IConstruct, IDependable, IInspectable, ITaggable

The AWS::GameLift::MatchmakingConfiguration resource defines a new matchmaking configuration for use with FlexMatch.

Whether you're using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're using GameLift hosting, it also defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes that are consistent with that configuration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_gamelift as gamelift } from 'aws-cdk-lib';
const cfnMatchmakingConfiguration = new gamelift.CfnMatchmakingConfiguration(this, 'MyCfnMatchmakingConfiguration', {
  acceptanceRequired: false,
  name: 'name',
  requestTimeoutSeconds: 123,
  ruleSetName: 'ruleSetName',

  // the properties below are optional
  acceptanceTimeoutSeconds: 123,
  additionalPlayerCount: 123,
  backfillMode: 'backfillMode',
  creationTime: 'creationTime',
  customEventData: 'customEventData',
  description: 'description',
  flexMatchMode: 'flexMatchMode',
  gameProperties: [{
    key: 'key',
    value: 'value',
  }],
  gameSessionData: 'gameSessionData',
  gameSessionQueueArns: ['gameSessionQueueArns'],
  notificationTarget: 'notificationTarget',
  ruleSetArn: 'ruleSetArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnMatchmakingConfiguration(scope: Construct, id: string, props: CfnMatchmakingConfigurationProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnMatchmakingConfigurationProps — Resource properties.

Construct Props

Name	Type	Description
acceptanceRequired	`boolean \|` `IResolvable`	A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
name	`string`	A unique identifier for the matchmaking configuration.
requestTimeoutSeconds	`number`	The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
ruleSetName	`string`	A unique identifier for the matchmaking rule set to use with this configuration.
acceptanceTimeoutSeconds?	`number`	The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
additionalPlayerCount?	`number`	The number of player slots in a match to keep open for future players.
backfillMode?	`string`	The method used to backfill game sessions that are created with this matchmaking configuration.
creationTime?	`string`	A time stamp indicating when this data object was created.
customEventData?	`string`	Information to add to all events related to the matchmaking configuration.
description?	`string`	A description for the matchmaking configuration.
flexMatchMode?	`string`	Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
gameProperties?	`IResolvable` `\|` `IResolvable` `\|` `GamePropertyProperty[]`	A set of custom properties for a game session, formatted as key-value pairs.
gameSessionData?	`string`	A set of custom game session properties, formatted as a single string value.
gameSessionQueueArns?	`string[]`	The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:<region>::gamesessionqueue/<queue name>` . Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If `FlexMatchMode` is set to `STANDALONE` , do not set this parameter.
notificationTarget?	`string`	An SNS topic ARN that is set up to receive matchmaking notifications.
ruleSetArn?	`string`	The Amazon Resource Name ( ARN ) associated with the GameLift matchmaking rule set resource that this configuration uses.
tags?	`CfnTag[]`	A list of labels to assign to the new matchmaking configuration resource.

acceptanceRequired

Type: boolean | IResolvable

A flag that determines whether a match that was created with this configuration must be accepted by the matched players.

To require acceptance, set to TRUE . With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

name

Type: string

A unique identifier for the matchmaking configuration.

This name is used to identify the configuration associated with a matchmaking request or ticket.

requestTimeoutSeconds

Type: number

The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.

Requests that fail due to timing out can be resubmitted as needed.

ruleSetName

Type: string

A unique identifier for the matchmaking rule set to use with this configuration.

You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

acceptanceTimeoutSeconds?

Type: number (optional)

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

additionalPlayerCount?

Type: number (optional)

The number of player slots in a match to keep open for future players.

For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if FlexMatchMode is set to STANDALONE .

backfillMode?

Type: string (optional)

The method used to backfill game sessions that are created with this matchmaking configuration.

Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch . Automatic backfill is not available when FlexMatchMode is set to STANDALONE .

creationTime?

Type: string (optional)

A time stamp indicating when this data object was created.

Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).

customEventData?

Type: string (optional)

Information to add to all events related to the matchmaking configuration.

description?

Type: string (optional)

A description for the matchmaking configuration.

flexMatchMode?

Type: string (optional)

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.
WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

gameProperties?

Type: IResolvable | IResolvable | GamePropertyProperty[] (optional)

A set of custom properties for a game session, formatted as key-value pairs.

These properties are passed to a game server process with a request to start a new game session. See Start a Game Session . This parameter is not used if FlexMatchMode is set to STANDALONE .

gameSessionData?

Type: string (optional)

A set of custom game session properties, formatted as a single string value.

This data is passed to a game server process with a request to start a new game session. See Start a Game Session . This parameter is not used if FlexMatchMode is set to STANDALONE .

gameSessionQueueArns?

Type: string[] (optional)

The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name> . Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE , do not set this parameter.

notificationTarget?

Type: string (optional)

An SNS topic ARN that is set up to receive matchmaking notifications.

See Setting up notifications for matchmaking for more information.

ruleSetArn?

Type: string (optional)

The Amazon Resource Name ( ARN ) associated with the GameLift matchmaking rule set resource that this configuration uses.

tags?

Type: CfnTag[] (optional)

A list of labels to assign to the new matchmaking configuration resource.

Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Properties

Name	Type	Description
acceptanceRequired	`boolean \|` `IResolvable`	A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
attrArn	`string`	The unique Amazon Resource Name (ARN) for the `MatchmakingConfiguration` .
attrName	`string`	The `MatchmakingConfiguration` name, which is unique.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	A unique identifier for the matchmaking configuration.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
requestTimeoutSeconds	`number`	The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
ruleSetName	`string`	A unique identifier for the matchmaking rule set to use with this configuration.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
acceptanceTimeoutSeconds?	`number`	The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
additionalPlayerCount?	`number`	The number of player slots in a match to keep open for future players.
backfillMode?	`string`	The method used to backfill game sessions that are created with this matchmaking configuration.
creationTime?	`string`	A time stamp indicating when this data object was created.
customEventData?	`string`	Information to add to all events related to the matchmaking configuration.
description?	`string`	A description for the matchmaking configuration.
flexMatchMode?	`string`	Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
gameProperties?	`IResolvable` `\|` `IResolvable` `\|` `GamePropertyProperty[]`	A set of custom properties for a game session, formatted as key-value pairs.
gameSessionData?	`string`	A set of custom game session properties, formatted as a single string value.
gameSessionQueueArns?	`string[]`	The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:<region>::gamesessionqueue/<queue name>` . Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If `FlexMatchMode` is set to `STANDALONE` , do not set this parameter.
notificationTarget?	`string`	An SNS topic ARN that is set up to receive matchmaking notifications.
ruleSetArn?	`string`	The Amazon Resource Name ( ARN ) associated with the GameLift matchmaking rule set resource that this configuration uses.
tagsRaw?	`CfnTag[]`	A list of labels to assign to the new matchmaking configuration resource.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

acceptanceRequired

Type: boolean | IResolvable

A flag that determines whether a match that was created with this configuration must be accepted by the matched players.

attrArn

Type: string

The unique Amazon Resource Name (ARN) for the MatchmakingConfiguration .

attrName

Type: string

The MatchmakingConfiguration name, which is unique.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name

Type: string

A unique identifier for the matchmaking configuration.

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

requestTimeoutSeconds

Type: number

The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.

ruleSetName

Type: string

A unique identifier for the matchmaking rule set to use with this configuration.

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

acceptanceTimeoutSeconds?

Type: number (optional)

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

additionalPlayerCount?

Type: number (optional)

The number of player slots in a match to keep open for future players.

backfillMode?

Type: string (optional)

The method used to backfill game sessions that are created with this matchmaking configuration.

creationTime?

Type: string (optional)

A time stamp indicating when this data object was created.

customEventData?

Type: string (optional)

Information to add to all events related to the matchmaking configuration.

description?

Type: string (optional)

A description for the matchmaking configuration.

flexMatchMode?

Type: string (optional)

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

gameProperties?

Type: IResolvable | IResolvable | GamePropertyProperty[] (optional)

A set of custom properties for a game session, formatted as key-value pairs.

gameSessionData?

Type: string (optional)

A set of custom game session properties, formatted as a single string value.

gameSessionQueueArns?

Type: string[] (optional)

notificationTarget?

Type: string (optional)

An SNS topic ARN that is set up to receive matchmaking notifications.

ruleSetArn?

Type: string (optional)

The Amazon Resource Name ( ARN ) associated with the GameLift matchmaking rule set resource that this configuration uses.

tagsRaw?

Type: CfnTag[] (optional)

A list of labels to assign to the new matchmaking configuration resource.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }