Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. gamelift
  5. MatchmakingConfiguration

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.gamelift.MatchmakingConfiguration

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::GameLift::MatchmakingConfiguration resource creates an Amazon GameLift (GameLift) matchmaking configuration.

Create MatchmakingConfiguration Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new MatchmakingConfiguration(name: string, args: MatchmakingConfigurationArgs, opts?: CustomResourceOptions);
@overload
def MatchmakingConfiguration(resource_name: str,
                             args: MatchmakingConfigurationArgs,
                             opts: Optional[ResourceOptions] = None)

@overload
def MatchmakingConfiguration(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             acceptance_required: Optional[bool] = None,
                             rule_set_name: Optional[str] = None,
                             request_timeout_seconds: Optional[int] = None,
                             game_properties: Optional[Sequence[MatchmakingConfigurationGamePropertyArgs]] = None,
                             game_session_queue_arns: Optional[Sequence[str]] = None,
                             custom_event_data: Optional[str] = None,
                             description: Optional[str] = None,
                             flex_match_mode: Optional[MatchmakingConfigurationFlexMatchMode] = None,
                             backfill_mode: Optional[MatchmakingConfigurationBackfillMode] = None,
                             game_session_data: Optional[str] = None,
                             creation_time: Optional[str] = None,
                             name: Optional[str] = None,
                             notification_target: Optional[str] = None,
                             additional_player_count: Optional[int] = None,
                             rule_set_arn: Optional[str] = None,
                             acceptance_timeout_seconds: Optional[int] = None,
                             tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewMatchmakingConfiguration(ctx *Context, name string, args MatchmakingConfigurationArgs, opts ...ResourceOption) (*MatchmakingConfiguration, error)
public MatchmakingConfiguration(string name, MatchmakingConfigurationArgs args, CustomResourceOptions? opts = null)
public MatchmakingConfiguration(String name, MatchmakingConfigurationArgs args)
public MatchmakingConfiguration(String name, MatchmakingConfigurationArgs args, CustomResourceOptions options)

type: aws-native:gamelift:MatchmakingConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MatchmakingConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MatchmakingConfigurationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MatchmakingConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MatchmakingConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MatchmakingConfigurationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

MatchmakingConfiguration Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The MatchmakingConfiguration resource accepts the following input properties:

AcceptanceRequired This property is required. bool
A flag that indicates whether a match that was created with this configuration must be accepted by the matched players
RequestTimeoutSeconds This property is required. int
The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
RuleSetName This property is required. string
A unique identifier for the matchmaking rule set to use with this configuration.
AcceptanceTimeoutSeconds int
The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
AdditionalPlayerCount int
The number of player slots in a match to keep open for future players.
BackfillMode Pulumi.AwsNative.GameLift.MatchmakingConfigurationBackfillMode
The method used to backfill game sessions created with this matchmaking configuration.
CreationTime string
A time stamp indicating when this data object was created.
CustomEventData string
Information to attach to all events related to the matchmaking configuration.
Description string
A descriptive label that is associated with matchmaking configuration.
FlexMatchMode Pulumi.AwsNative.GameLift.MatchmakingConfigurationFlexMatchMode
Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
GameProperties List<Pulumi.AwsNative.GameLift.Inputs.MatchmakingConfigurationGameProperty>
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 List<string>
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
Name string
A unique identifier for the matchmaking configuration.
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 List<Pulumi.AwsNative.Inputs.Tag>
An array of key-value pairs to apply to this resource.
AcceptanceRequired This property is required. bool
A flag that indicates whether a match that was created with this configuration must be accepted by the matched players
RequestTimeoutSeconds This property is required. int
The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
RuleSetName This property is required. string
A unique identifier for the matchmaking rule set to use with this configuration.
AcceptanceTimeoutSeconds int
The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
AdditionalPlayerCount int
The number of player slots in a match to keep open for future players.
BackfillMode MatchmakingConfigurationBackfillMode
The method used to backfill game sessions created with this matchmaking configuration.
CreationTime string
A time stamp indicating when this data object was created.
CustomEventData string
Information to attach to all events related to the matchmaking configuration.
Description string
A descriptive label that is associated with matchmaking configuration.
FlexMatchMode MatchmakingConfigurationFlexMatchMode
Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
GameProperties []MatchmakingConfigurationGamePropertyArgs
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.
Name string
A unique identifier for the matchmaking configuration.
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 TagArgs
An array of key-value pairs to apply to this resource.
acceptanceRequired This property is required. Boolean
A flag that indicates whether a match that was created with this configuration must be accepted by the matched players
requestTimeoutSeconds This property is required. Integer
The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
ruleSetName This property is required. String
A unique identifier for the matchmaking rule set to use with this configuration.
acceptanceTimeoutSeconds Integer
The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
additionalPlayerCount Integer
The number of player slots in a match to keep open for future players.
backfillMode MatchmakingConfigurationBackfillMode
The method used to backfill game sessions created with this matchmaking configuration.
creationTime String
A time stamp indicating when this data object was created.
customEventData String
Information to attach to all events related to the matchmaking configuration.
description String
A descriptive label that is associated with matchmaking configuration.
flexMatchMode MatchmakingConfigurationFlexMatchMode
Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
gameProperties List<MatchmakingConfigurationGameProperty>
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 List<String>
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
name String
A unique identifier for the matchmaking configuration.
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 List<Tag>
An array of key-value pairs to apply to this resource.
acceptanceRequired This property is required. boolean
A flag that indicates whether a match that was created with this configuration must be accepted by the matched players
requestTimeoutSeconds This property is required. number
The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
ruleSetName This property is required. 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 MatchmakingConfigurationBackfillMode
The method used to backfill game sessions created with this matchmaking configuration.
creationTime string
A time stamp indicating when this data object was created.
customEventData string
Information to attach to all events related to the matchmaking configuration.
description string
A descriptive label that is associated with matchmaking configuration.
flexMatchMode MatchmakingConfigurationFlexMatchMode
Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
gameProperties MatchmakingConfigurationGameProperty[]
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.
name string
A unique identifier for the matchmaking configuration.
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 Tag[]
An array of key-value pairs to apply to this resource.
acceptance_required This property is required. bool
A flag that indicates whether a match that was created with this configuration must be accepted by the matched players
request_timeout_seconds This property is required. int
The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
rule_set_name This property is required. str
A unique identifier for the matchmaking rule set to use with this configuration.
acceptance_timeout_seconds int
The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
additional_player_count int
The number of player slots in a match to keep open for future players.
backfill_mode MatchmakingConfigurationBackfillMode
The method used to backfill game sessions created with this matchmaking configuration.
creation_time str
A time stamp indicating when this data object was created.
custom_event_data str
Information to attach to all events related to the matchmaking configuration.
description str
A descriptive label that is associated with matchmaking configuration.
flex_match_mode MatchmakingConfigurationFlexMatchMode
Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
game_properties Sequence[MatchmakingConfigurationGamePropertyArgs]
A set of custom properties for a game session, formatted as key:value pairs.
game_session_data str
A set of custom game session properties, formatted as a single string value.
game_session_queue_arns Sequence[str]
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
name str
A unique identifier for the matchmaking configuration.
notification_target str
An SNS topic ARN that is set up to receive matchmaking notifications.
rule_set_arn str
The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
tags Sequence[TagArgs]
An array of key-value pairs to apply to this resource.
acceptanceRequired This property is required. Boolean
A flag that indicates whether a match that was created with this configuration must be accepted by the matched players
requestTimeoutSeconds This property is required. Number
The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
ruleSetName This property is required. 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 "AUTOMATIC" | "MANUAL"
The method used to backfill game sessions created with this matchmaking configuration.
creationTime String
A time stamp indicating when this data object was created.
customEventData String
Information to attach to all events related to the matchmaking configuration.
description String
A descriptive label that is associated with matchmaking configuration.
flexMatchMode "STANDALONE" | "WITH_QUEUE"
Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
gameProperties List<Property Map>
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 List<String>
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
name String
A unique identifier for the matchmaking configuration.
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 List<Property Map>
An array of key-value pairs to apply to this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the MatchmakingConfiguration resource produces the following output properties:

Arn string
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
Id string
The provider-assigned unique ID for this managed resource.
Arn string
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
Id string
The provider-assigned unique ID for this managed resource.
arn String
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
id String
The provider-assigned unique ID for this managed resource.
arn string
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
id string
The provider-assigned unique ID for this managed resource.
arn str
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
id str
The provider-assigned unique ID for this managed resource.
arn String
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

MatchmakingConfigurationBackfillMode
, MatchmakingConfigurationBackfillModeArgs

Automatic
AUTOMATIC
Manual
MANUAL
MatchmakingConfigurationBackfillModeAutomatic
AUTOMATIC
MatchmakingConfigurationBackfillModeManual
MANUAL
Automatic
AUTOMATIC
Manual
MANUAL
Automatic
AUTOMATIC
Manual
MANUAL
AUTOMATIC
AUTOMATIC
MANUAL
MANUAL
"AUTOMATIC"
AUTOMATIC
"MANUAL"
MANUAL

MatchmakingConfigurationFlexMatchMode
, MatchmakingConfigurationFlexMatchModeArgs

Standalone
STANDALONE
WithQueue
WITH_QUEUE
MatchmakingConfigurationFlexMatchModeStandalone
STANDALONE
MatchmakingConfigurationFlexMatchModeWithQueue
WITH_QUEUE
Standalone
STANDALONE
WithQueue
WITH_QUEUE
Standalone
STANDALONE
WithQueue
WITH_QUEUE
STANDALONE
STANDALONE
WITH_QUEUE
WITH_QUEUE
"STANDALONE"
STANDALONE
"WITH_QUEUE"
WITH_QUEUE

MatchmakingConfigurationGameProperty
, MatchmakingConfigurationGamePropertyArgs

Key This property is required. string
The game property identifier.
Value This property is required. string
The game property value.
Key This property is required. string
The game property identifier.
Value This property is required. string
The game property value.
key This property is required. String
The game property identifier.
value This property is required. String
The game property value.
key This property is required. string
The game property identifier.
value This property is required. string
The game property value.
key This property is required. str
The game property identifier.
value This property is required. str
The game property value.
key This property is required. String
The game property identifier.
value This property is required. String
The game property value.

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native