interface CfnMatchmakingConfigurationProps

Language	Type name
.NET	`Amazon.CDK.AWS.GameLift.CfnMatchmakingConfigurationProps`
Java	`software.amazon.awscdk.services.gamelift.CfnMatchmakingConfigurationProps`
Python	`aws_cdk.aws_gamelift.CfnMatchmakingConfigurationProps`
TypeScript	`@aws-cdk/aws-gamelift` » `CfnMatchmakingConfigurationProps`

Properties for defining a CfnMatchmakingConfiguration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as gamelift from '@aws-cdk/aws-gamelift';
const cfnMatchmakingConfigurationProps: gamelift.CfnMatchmakingConfigurationProps = {
  acceptanceRequired: false,
  name: 'name',
  requestTimeoutSeconds: 123,
  ruleSetName: 'ruleSetName',

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

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.
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.
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.
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 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. 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 .

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.

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.