1. Packages
  2. AWS
  3. API Docs
  4. gamelift
  5. MatchmakingConfiguration
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
aws logo
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi

    Provides a GameLift Alias resource.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleGameSessionQueue = new Aws.GameLift.GameSessionQueue("exampleGameSessionQueue", new()
        {
            Destinations = new[] {},
            PlayerLatencyPolicies = new[]
            {
                new Aws.GameLift.Inputs.GameSessionQueuePlayerLatencyPolicyArgs
                {
                    MaximumIndividualPlayerLatencyMilliseconds = 3,
                    PolicyDurationSeconds = 7,
                },
                new Aws.GameLift.Inputs.GameSessionQueuePlayerLatencyPolicyArgs
                {
                    MaximumIndividualPlayerLatencyMilliseconds = 10,
                },
            },
            TimeoutInSeconds = 25,
        });
    
        var exampleMatchmakingRuleSet = new Aws.GameLift.MatchmakingRuleSet("exampleMatchmakingRuleSet", new()
        {
            RuleSetBody = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["name"] = "test",
                ["ruleLanguageVersion"] = "1.0",
                ["teams"] = new[]
                {
                    new Dictionary<string, object?>
                    {
                        ["name"] = "alpha",
                        ["minPlayers"] = 1,
                        ["maxPlayers"] = 5,
                    },
                },
            }),
        });
    
        var exampleMatchmakingConfiguration = new Aws.GameLift.MatchmakingConfiguration("exampleMatchmakingConfiguration", new()
        {
            AcceptanceRequired = false,
            CustomEventData = "pvp",
            GameSessionData = "game_session_data",
            BackfillMode = "MANUAL",
            RequestTimeoutSeconds = 30,
            RuleSetName = aws_gamelift_matchmaking_rule_set.Test.Name,
            GameSessionQueueArns = new[]
            {
                aws_gamelift_game_session_queue.Test.Arn,
            },
            Tags = 
            {
                { "key1", "value1" },
            },
        });
    
    });
    
    package main
    
    import (
    	"encoding/json"
    
    	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/gamelift"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := gamelift.NewGameSessionQueue(ctx, "exampleGameSessionQueue", &gamelift.GameSessionQueueArgs{
    			Destinations: pulumi.StringArray{},
    			PlayerLatencyPolicies: gamelift.GameSessionQueuePlayerLatencyPolicyArray{
    				&gamelift.GameSessionQueuePlayerLatencyPolicyArgs{
    					MaximumIndividualPlayerLatencyMilliseconds: pulumi.Int(3),
    					PolicyDurationSeconds:                      pulumi.Int(7),
    				},
    				&gamelift.GameSessionQueuePlayerLatencyPolicyArgs{
    					MaximumIndividualPlayerLatencyMilliseconds: pulumi.Int(10),
    				},
    			},
    			TimeoutInSeconds: pulumi.Int(25),
    		})
    		if err != nil {
    			return err
    		}
    		tmpJSON0, err := json.Marshal(map[string]interface{}{
    			"name":                "test",
    			"ruleLanguageVersion": "1.0",
    			"teams": []map[string]interface{}{
    				map[string]interface{}{
    					"name":       "alpha",
    					"minPlayers": 1,
    					"maxPlayers": 5,
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		_, err = gamelift.NewMatchmakingRuleSet(ctx, "exampleMatchmakingRuleSet", &gamelift.MatchmakingRuleSetArgs{
    			RuleSetBody: pulumi.String(json0),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = gamelift.NewMatchmakingConfiguration(ctx, "exampleMatchmakingConfiguration", &gamelift.MatchmakingConfigurationArgs{
    			AcceptanceRequired:    pulumi.Bool(false),
    			CustomEventData:       pulumi.String("pvp"),
    			GameSessionData:       pulumi.String("game_session_data"),
    			BackfillMode:          pulumi.String("MANUAL"),
    			RequestTimeoutSeconds: pulumi.Int(30),
    			RuleSetName:           pulumi.Any(aws_gamelift_matchmaking_rule_set.Test.Name),
    			GameSessionQueueArns: pulumi.StringArray{
    				aws_gamelift_game_session_queue.Test.Arn,
    			},
    			Tags: pulumi.StringMap{
    				"key1": pulumi.String("value1"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.gamelift.GameSessionQueue;
    import com.pulumi.aws.gamelift.GameSessionQueueArgs;
    import com.pulumi.aws.gamelift.inputs.GameSessionQueuePlayerLatencyPolicyArgs;
    import com.pulumi.aws.gamelift.MatchmakingRuleSet;
    import com.pulumi.aws.gamelift.MatchmakingRuleSetArgs;
    import com.pulumi.aws.gamelift.MatchmakingConfiguration;
    import com.pulumi.aws.gamelift.MatchmakingConfigurationArgs;
    import static com.pulumi.codegen.internal.Serialization.*;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var exampleGameSessionQueue = new GameSessionQueue("exampleGameSessionQueue", GameSessionQueueArgs.builder()        
                .destinations()
                .playerLatencyPolicies(            
                    GameSessionQueuePlayerLatencyPolicyArgs.builder()
                        .maximumIndividualPlayerLatencyMilliseconds(3)
                        .policyDurationSeconds(7)
                        .build(),
                    GameSessionQueuePlayerLatencyPolicyArgs.builder()
                        .maximumIndividualPlayerLatencyMilliseconds(10)
                        .build())
                .timeoutInSeconds(25)
                .build());
    
            var exampleMatchmakingRuleSet = new MatchmakingRuleSet("exampleMatchmakingRuleSet", MatchmakingRuleSetArgs.builder()        
                .ruleSetBody(serializeJson(
                    jsonObject(
                        jsonProperty("name", "test"),
                        jsonProperty("ruleLanguageVersion", "1.0"),
                        jsonProperty("teams", jsonArray(jsonObject(
                            jsonProperty("name", "alpha"),
                            jsonProperty("minPlayers", 1),
                            jsonProperty("maxPlayers", 5)
                        )))
                    )))
                .build());
    
            var exampleMatchmakingConfiguration = new MatchmakingConfiguration("exampleMatchmakingConfiguration", MatchmakingConfigurationArgs.builder()        
                .acceptanceRequired(false)
                .customEventData("pvp")
                .gameSessionData("game_session_data")
                .backfillMode("MANUAL")
                .requestTimeoutSeconds(30)
                .ruleSetName(aws_gamelift_matchmaking_rule_set.test().name())
                .gameSessionQueueArns(aws_gamelift_game_session_queue.test().arn())
                .tags(Map.of("key1", "value1"))
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const exampleGameSessionQueue = new aws.gamelift.GameSessionQueue("exampleGameSessionQueue", {
        destinations: [],
        playerLatencyPolicies: [
            {
                maximumIndividualPlayerLatencyMilliseconds: 3,
                policyDurationSeconds: 7,
            },
            {
                maximumIndividualPlayerLatencyMilliseconds: 10,
            },
        ],
        timeoutInSeconds: 25,
    });
    const exampleMatchmakingRuleSet = new aws.gamelift.MatchmakingRuleSet("exampleMatchmakingRuleSet", {ruleSetBody: JSON.stringify({
        name: "test",
        ruleLanguageVersion: "1.0",
        teams: [{
            name: "alpha",
            minPlayers: 1,
            maxPlayers: 5,
        }],
    })});
    const exampleMatchmakingConfiguration = new aws.gamelift.MatchmakingConfiguration("exampleMatchmakingConfiguration", {
        acceptanceRequired: false,
        customEventData: "pvp",
        gameSessionData: "game_session_data",
        backfillMode: "MANUAL",
        requestTimeoutSeconds: 30,
        ruleSetName: aws_gamelift_matchmaking_rule_set.test.name,
        gameSessionQueueArns: [aws_gamelift_game_session_queue.test.arn],
        tags: {
            key1: "value1",
        },
    });
    
    import pulumi
    import json
    import pulumi_aws as aws
    
    example_game_session_queue = aws.gamelift.GameSessionQueue("exampleGameSessionQueue",
        destinations=[],
        player_latency_policies=[
            aws.gamelift.GameSessionQueuePlayerLatencyPolicyArgs(
                maximum_individual_player_latency_milliseconds=3,
                policy_duration_seconds=7,
            ),
            aws.gamelift.GameSessionQueuePlayerLatencyPolicyArgs(
                maximum_individual_player_latency_milliseconds=10,
            ),
        ],
        timeout_in_seconds=25)
    example_matchmaking_rule_set = aws.gamelift.MatchmakingRuleSet("exampleMatchmakingRuleSet", rule_set_body=json.dumps({
        "name": "test",
        "ruleLanguageVersion": "1.0",
        "teams": [{
            "name": "alpha",
            "minPlayers": 1,
            "maxPlayers": 5,
        }],
    }))
    example_matchmaking_configuration = aws.gamelift.MatchmakingConfiguration("exampleMatchmakingConfiguration",
        acceptance_required=False,
        custom_event_data="pvp",
        game_session_data="game_session_data",
        backfill_mode="MANUAL",
        request_timeout_seconds=30,
        rule_set_name=aws_gamelift_matchmaking_rule_set["test"]["name"],
        game_session_queue_arns=[aws_gamelift_game_session_queue["test"]["arn"]],
        tags={
            "key1": "value1",
        })
    
    resources:
      exampleGameSessionQueue:
        type: aws:gamelift:GameSessionQueue
        properties:
          destinations: []
          playerLatencyPolicies:
            - maximumIndividualPlayerLatencyMilliseconds: 3
              policyDurationSeconds: 7
            - maximumIndividualPlayerLatencyMilliseconds: 10
          timeoutInSeconds: 25
      exampleMatchmakingRuleSet:
        type: aws:gamelift:MatchmakingRuleSet
        properties:
          ruleSetBody:
            fn::toJSON:
              name: test
              ruleLanguageVersion: '1.0'
              teams:
                - name: alpha
                  minPlayers: 1
                  maxPlayers: 5
      exampleMatchmakingConfiguration:
        type: aws:gamelift:MatchmakingConfiguration
        properties:
          acceptanceRequired: false
          customEventData: pvp
          gameSessionData: game_session_data
          backfillMode: MANUAL
          requestTimeoutSeconds: 30
          ruleSetName: ${aws_gamelift_matchmaking_rule_set.test.name}
          gameSessionQueueArns:
            - ${aws_gamelift_game_session_queue.test.arn}
          tags:
            key1: value1
    

    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,
                                 request_timeout_seconds: Optional[int] = None,
                                 rule_set_name: Optional[str] = None,
                                 flex_match_mode: Optional[str] = None,
                                 backfill_mode: Optional[str] = None,
                                 custom_event_data: Optional[str] = None,
                                 description: Optional[str] = None,
                                 acceptance_required: Optional[bool] = None,
                                 game_properties: Optional[Sequence[MatchmakingConfigurationGamePropertyArgs]] = None,
                                 game_session_data: Optional[str] = None,
                                 game_session_queue_arns: Optional[Sequence[str]] = None,
                                 name: Optional[str] = None,
                                 notification_target: Optional[str] = None,
                                 additional_player_count: Optional[int] = None,
                                 acceptance_timeout_seconds: Optional[int] = None,
                                 tags: Optional[Mapping[str, str]] = 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:gamelift:MatchmakingConfiguration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args MatchmakingConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args MatchmakingConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MatchmakingConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MatchmakingConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var matchmakingConfigurationResource = new Aws.GameLift.MatchmakingConfiguration("matchmakingConfigurationResource", new()
    {
        RequestTimeoutSeconds = 0,
        RuleSetName = "string",
        FlexMatchMode = "string",
        BackfillMode = "string",
        CustomEventData = "string",
        Description = "string",
        AcceptanceRequired = false,
        GameProperties = new[]
        {
            new Aws.GameLift.Inputs.MatchmakingConfigurationGamePropertyArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        GameSessionData = "string",
        GameSessionQueueArns = new[]
        {
            "string",
        },
        Name = "string",
        NotificationTarget = "string",
        AdditionalPlayerCount = 0,
        AcceptanceTimeoutSeconds = 0,
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := gamelift.NewMatchmakingConfiguration(ctx, "matchmakingConfigurationResource", &gamelift.MatchmakingConfigurationArgs{
    	RequestTimeoutSeconds: pulumi.Int(0),
    	RuleSetName:           pulumi.String("string"),
    	FlexMatchMode:         pulumi.String("string"),
    	BackfillMode:          pulumi.String("string"),
    	CustomEventData:       pulumi.String("string"),
    	Description:           pulumi.String("string"),
    	AcceptanceRequired:    pulumi.Bool(false),
    	GameProperties: gamelift.MatchmakingConfigurationGamePropertyArray{
    		&gamelift.MatchmakingConfigurationGamePropertyArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	GameSessionData: pulumi.String("string"),
    	GameSessionQueueArns: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name:                     pulumi.String("string"),
    	NotificationTarget:       pulumi.String("string"),
    	AdditionalPlayerCount:    pulumi.Int(0),
    	AcceptanceTimeoutSeconds: pulumi.Int(0),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var matchmakingConfigurationResource = new MatchmakingConfiguration("matchmakingConfigurationResource", MatchmakingConfigurationArgs.builder()
        .requestTimeoutSeconds(0)
        .ruleSetName("string")
        .flexMatchMode("string")
        .backfillMode("string")
        .customEventData("string")
        .description("string")
        .acceptanceRequired(false)
        .gameProperties(MatchmakingConfigurationGamePropertyArgs.builder()
            .key("string")
            .value("string")
            .build())
        .gameSessionData("string")
        .gameSessionQueueArns("string")
        .name("string")
        .notificationTarget("string")
        .additionalPlayerCount(0)
        .acceptanceTimeoutSeconds(0)
        .tags(Map.of("string", "string"))
        .build());
    
    matchmaking_configuration_resource = aws.gamelift.MatchmakingConfiguration("matchmakingConfigurationResource",
        request_timeout_seconds=0,
        rule_set_name="string",
        flex_match_mode="string",
        backfill_mode="string",
        custom_event_data="string",
        description="string",
        acceptance_required=False,
        game_properties=[{
            "key": "string",
            "value": "string",
        }],
        game_session_data="string",
        game_session_queue_arns=["string"],
        name="string",
        notification_target="string",
        additional_player_count=0,
        acceptance_timeout_seconds=0,
        tags={
            "string": "string",
        })
    
    const matchmakingConfigurationResource = new aws.gamelift.MatchmakingConfiguration("matchmakingConfigurationResource", {
        requestTimeoutSeconds: 0,
        ruleSetName: "string",
        flexMatchMode: "string",
        backfillMode: "string",
        customEventData: "string",
        description: "string",
        acceptanceRequired: false,
        gameProperties: [{
            key: "string",
            value: "string",
        }],
        gameSessionData: "string",
        gameSessionQueueArns: ["string"],
        name: "string",
        notificationTarget: "string",
        additionalPlayerCount: 0,
        acceptanceTimeoutSeconds: 0,
        tags: {
            string: "string",
        },
    });
    
    type: aws:gamelift:MatchmakingConfiguration
    properties:
        acceptanceRequired: false
        acceptanceTimeoutSeconds: 0
        additionalPlayerCount: 0
        backfillMode: string
        customEventData: string
        description: string
        flexMatchMode: string
        gameProperties:
            - key: string
              value: string
        gameSessionData: string
        gameSessionQueueArns:
            - string
        name: string
        notificationTarget: string
        requestTimeoutSeconds: 0
        ruleSetName: string
        tags:
            string: string
    

    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:

    RequestTimeoutSeconds int
    The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
    RuleSetName string
    A rule set names for the matchmaking rule set to use with this configuration.
    AcceptanceRequired bool
    Specifies if the match that was created with this configuration must be accepted by matched players.
    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 string
    The method used to backfill game sessions that are created with this matchmaking configuration.
    CustomEventData string
    Information to be added to all events related to this matchmaking configuration.
    Description string
    A human-readable description of the matchmaking configuration.
    FlexMatchMode string
    Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
    GameProperties List<MatchmakingConfigurationGameProperty>
    One or more custom game properties. See below.
    GameSessionData string
    A set of custom game session properties.
    GameSessionQueueArns List<string>
    The ARNs of the GameLift game session queue resources.
    Name string
    Name of the matchmaking configuration
    NotificationTarget string
    An SNS topic ARN that is set up to receive matchmaking notifications.
    Tags Dictionary<string, string>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    RequestTimeoutSeconds int
    The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
    RuleSetName string
    A rule set names for the matchmaking rule set to use with this configuration.
    AcceptanceRequired bool
    Specifies if the match that was created with this configuration must be accepted by matched players.
    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 string
    The method used to backfill game sessions that are created with this matchmaking configuration.
    CustomEventData string
    Information to be added to all events related to this matchmaking configuration.
    Description string
    A human-readable description of the matchmaking configuration.
    FlexMatchMode string
    Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
    GameProperties []MatchmakingConfigurationGamePropertyArgs
    One or more custom game properties. See below.
    GameSessionData string
    A set of custom game session properties.
    GameSessionQueueArns []string
    The ARNs of the GameLift game session queue resources.
    Name string
    Name of the matchmaking configuration
    NotificationTarget string
    An SNS topic ARN that is set up to receive matchmaking notifications.
    Tags map[string]string
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    requestTimeoutSeconds Integer
    The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
    ruleSetName String
    A rule set names for the matchmaking rule set to use with this configuration.
    acceptanceRequired Boolean
    Specifies if the match that was created with this configuration must be accepted by matched players.
    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 String
    The method used to backfill game sessions that are created with this matchmaking configuration.
    customEventData String
    Information to be added to all events related to this matchmaking configuration.
    description String
    A human-readable description of the matchmaking configuration.
    flexMatchMode String
    Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
    gameProperties List<MatchmakingConfigurationGameProperty>
    One or more custom game properties. See below.
    gameSessionData String
    A set of custom game session properties.
    gameSessionQueueArns List<String>
    The ARNs of the GameLift game session queue resources.
    name String
    Name of the matchmaking configuration
    notificationTarget String
    An SNS topic ARN that is set up to receive matchmaking notifications.
    tags Map<String,String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    requestTimeoutSeconds number
    The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
    ruleSetName string
    A rule set names for the matchmaking rule set to use with this configuration.
    acceptanceRequired boolean
    Specifies if the match that was created with this configuration must be accepted by matched players.
    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 be added to all events related to this matchmaking configuration.
    description string
    A human-readable description of the matchmaking configuration.
    flexMatchMode string
    Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
    gameProperties MatchmakingConfigurationGameProperty[]
    One or more custom game properties. See below.
    gameSessionData string
    A set of custom game session properties.
    gameSessionQueueArns string[]
    The ARNs of the GameLift game session queue resources.
    name string
    Name of the matchmaking configuration
    notificationTarget string
    An SNS topic ARN that is set up to receive matchmaking notifications.
    tags {[key: string]: string}
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    request_timeout_seconds int
    The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
    rule_set_name str
    A rule set names for the matchmaking rule set to use with this configuration.
    acceptance_required bool
    Specifies if the match that was created with this configuration must be accepted by matched players.
    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 str
    The method used to backfill game sessions that are created with this matchmaking configuration.
    custom_event_data str
    Information to be added to all events related to this matchmaking configuration.
    description str
    A human-readable description of the matchmaking configuration.
    flex_match_mode str
    Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
    game_properties Sequence[MatchmakingConfigurationGamePropertyArgs]
    One or more custom game properties. See below.
    game_session_data str
    A set of custom game session properties.
    game_session_queue_arns Sequence[str]
    The ARNs of the GameLift game session queue resources.
    name str
    Name of the matchmaking configuration
    notification_target str
    An SNS topic ARN that is set up to receive matchmaking notifications.
    tags Mapping[str, str]
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    requestTimeoutSeconds Number
    The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
    ruleSetName String
    A rule set names for the matchmaking rule set to use with this configuration.
    acceptanceRequired Boolean
    Specifies if the match that was created with this configuration must be accepted by matched players.
    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 be added to all events related to this matchmaking configuration.
    description String
    A human-readable description of the matchmaking configuration.
    flexMatchMode String
    Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
    gameProperties List<Property Map>
    One or more custom game properties. See below.
    gameSessionData String
    A set of custom game session properties.
    gameSessionQueueArns List<String>
    The ARNs of the GameLift game session queue resources.
    name String
    Name of the matchmaking configuration
    notificationTarget String
    An SNS topic ARN that is set up to receive matchmaking notifications.
    tags Map<String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    Matchmaking Configuration ARN.
    CreationTime string
    The time when the Matchmaking Configuration was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleSetArn string
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Arn string
    Matchmaking Configuration ARN.
    CreationTime string
    The time when the Matchmaking Configuration was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleSetArn string
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    Matchmaking Configuration ARN.
    creationTime String
    The time when the Matchmaking Configuration was created.
    id String
    The provider-assigned unique ID for this managed resource.
    ruleSetArn String
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn string
    Matchmaking Configuration ARN.
    creationTime string
    The time when the Matchmaking Configuration was created.
    id string
    The provider-assigned unique ID for this managed resource.
    ruleSetArn string
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn str
    Matchmaking Configuration ARN.
    creation_time str
    The time when the Matchmaking Configuration was created.
    id str
    The provider-assigned unique ID for this managed resource.
    rule_set_arn str
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    Matchmaking Configuration ARN.
    creationTime String
    The time when the Matchmaking Configuration was created.
    id String
    The provider-assigned unique ID for this managed resource.
    ruleSetArn String
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Look up Existing MatchmakingConfiguration Resource

    Get an existing MatchmakingConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: MatchmakingConfigurationState, opts?: CustomResourceOptions): MatchmakingConfiguration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            acceptance_required: Optional[bool] = None,
            acceptance_timeout_seconds: Optional[int] = None,
            additional_player_count: Optional[int] = None,
            arn: Optional[str] = None,
            backfill_mode: Optional[str] = None,
            creation_time: Optional[str] = None,
            custom_event_data: Optional[str] = None,
            description: Optional[str] = None,
            flex_match_mode: Optional[str] = None,
            game_properties: Optional[Sequence[MatchmakingConfigurationGamePropertyArgs]] = None,
            game_session_data: Optional[str] = None,
            game_session_queue_arns: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            notification_target: Optional[str] = None,
            request_timeout_seconds: Optional[int] = None,
            rule_set_arn: Optional[str] = None,
            rule_set_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> MatchmakingConfiguration
    func GetMatchmakingConfiguration(ctx *Context, name string, id IDInput, state *MatchmakingConfigurationState, opts ...ResourceOption) (*MatchmakingConfiguration, error)
    public static MatchmakingConfiguration Get(string name, Input<string> id, MatchmakingConfigurationState? state, CustomResourceOptions? opts = null)
    public static MatchmakingConfiguration get(String name, Output<String> id, MatchmakingConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: aws:gamelift:MatchmakingConfiguration    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AcceptanceRequired bool
    Specifies if the match that was created with this configuration must be accepted by matched players.
    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.
    Arn string
    Matchmaking Configuration ARN.
    BackfillMode string
    The method used to backfill game sessions that are created with this matchmaking configuration.
    CreationTime string
    The time when the Matchmaking Configuration was created.
    CustomEventData string
    Information to be added to all events related to this matchmaking configuration.
    Description string
    A human-readable description of the matchmaking configuration.
    FlexMatchMode string
    Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
    GameProperties List<MatchmakingConfigurationGameProperty>
    One or more custom game properties. See below.
    GameSessionData string
    A set of custom game session properties.
    GameSessionQueueArns List<string>
    The ARNs of the GameLift game session queue resources.
    Name string
    Name of the matchmaking configuration
    NotificationTarget string
    An SNS topic ARN that is set up to receive matchmaking notifications.
    RequestTimeoutSeconds int
    The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
    RuleSetArn string
    RuleSetName string
    A rule set names for the matchmaking rule set to use with this configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    AcceptanceRequired bool
    Specifies if the match that was created with this configuration must be accepted by matched players.
    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.
    Arn string
    Matchmaking Configuration ARN.
    BackfillMode string
    The method used to backfill game sessions that are created with this matchmaking configuration.
    CreationTime string
    The time when the Matchmaking Configuration was created.
    CustomEventData string
    Information to be added to all events related to this matchmaking configuration.
    Description string
    A human-readable description of the matchmaking configuration.
    FlexMatchMode string
    Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
    GameProperties []MatchmakingConfigurationGamePropertyArgs
    One or more custom game properties. See below.
    GameSessionData string
    A set of custom game session properties.
    GameSessionQueueArns []string
    The ARNs of the GameLift game session queue resources.
    Name string
    Name of the matchmaking configuration
    NotificationTarget string
    An SNS topic ARN that is set up to receive matchmaking notifications.
    RequestTimeoutSeconds int
    The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
    RuleSetArn string
    RuleSetName string
    A rule set names for the matchmaking rule set to use with this configuration.
    Tags map[string]string
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    acceptanceRequired Boolean
    Specifies if the match that was created with this configuration must be accepted by matched players.
    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.
    arn String
    Matchmaking Configuration ARN.
    backfillMode String
    The method used to backfill game sessions that are created with this matchmaking configuration.
    creationTime String
    The time when the Matchmaking Configuration was created.
    customEventData String
    Information to be added to all events related to this matchmaking configuration.
    description String
    A human-readable description of the matchmaking configuration.
    flexMatchMode String
    Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
    gameProperties List<MatchmakingConfigurationGameProperty>
    One or more custom game properties. See below.
    gameSessionData String
    A set of custom game session properties.
    gameSessionQueueArns List<String>
    The ARNs of the GameLift game session queue resources.
    name String
    Name of the matchmaking configuration
    notificationTarget String
    An SNS topic ARN that is set up to receive matchmaking notifications.
    requestTimeoutSeconds Integer
    The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
    ruleSetArn String
    ruleSetName String
    A rule set names for the matchmaking rule set to use with this configuration.
    tags Map<String,String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    acceptanceRequired boolean
    Specifies if the match that was created with this configuration must be accepted by matched players.
    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.
    arn string
    Matchmaking Configuration ARN.
    backfillMode string
    The method used to backfill game sessions that are created with this matchmaking configuration.
    creationTime string
    The time when the Matchmaking Configuration was created.
    customEventData string
    Information to be added to all events related to this matchmaking configuration.
    description string
    A human-readable description of the matchmaking configuration.
    flexMatchMode string
    Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
    gameProperties MatchmakingConfigurationGameProperty[]
    One or more custom game properties. See below.
    gameSessionData string
    A set of custom game session properties.
    gameSessionQueueArns string[]
    The ARNs of the GameLift game session queue resources.
    name string
    Name of the matchmaking configuration
    notificationTarget string
    An SNS topic ARN that is set up to receive matchmaking notifications.
    requestTimeoutSeconds number
    The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
    ruleSetArn string
    ruleSetName string
    A rule set names for the matchmaking rule set to use with this configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    acceptance_required bool
    Specifies if the match that was created with this configuration must be accepted by matched players.
    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.
    arn str
    Matchmaking Configuration ARN.
    backfill_mode str
    The method used to backfill game sessions that are created with this matchmaking configuration.
    creation_time str
    The time when the Matchmaking Configuration was created.
    custom_event_data str
    Information to be added to all events related to this matchmaking configuration.
    description str
    A human-readable description of the matchmaking configuration.
    flex_match_mode str
    Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
    game_properties Sequence[MatchmakingConfigurationGamePropertyArgs]
    One or more custom game properties. See below.
    game_session_data str
    A set of custom game session properties.
    game_session_queue_arns Sequence[str]
    The ARNs of the GameLift game session queue resources.
    name str
    Name of the matchmaking configuration
    notification_target str
    An SNS topic ARN that is set up to receive matchmaking notifications.
    request_timeout_seconds int
    The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
    rule_set_arn str
    rule_set_name str
    A rule set names for the matchmaking rule set to use with this configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    acceptanceRequired Boolean
    Specifies if the match that was created with this configuration must be accepted by matched players.
    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.
    arn String
    Matchmaking Configuration ARN.
    backfillMode String
    The method used to backfill game sessions that are created with this matchmaking configuration.
    creationTime String
    The time when the Matchmaking Configuration was created.
    customEventData String
    Information to be added to all events related to this matchmaking configuration.
    description String
    A human-readable description of the matchmaking configuration.
    flexMatchMode String
    Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
    gameProperties List<Property Map>
    One or more custom game properties. See below.
    gameSessionData String
    A set of custom game session properties.
    gameSessionQueueArns List<String>
    The ARNs of the GameLift game session queue resources.
    name String
    Name of the matchmaking configuration
    notificationTarget String
    An SNS topic ARN that is set up to receive matchmaking notifications.
    requestTimeoutSeconds Number
    The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
    ruleSetArn String
    ruleSetName String
    A rule set names for the matchmaking rule set to use with this configuration.
    tags Map<String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Supporting Types

    MatchmakingConfigurationGameProperty, MatchmakingConfigurationGamePropertyArgs

    Key string
    A game property key
    Value string
    A game property value.
    Key string
    A game property key
    Value string
    A game property value.
    key String
    A game property key
    value String
    A game property value.
    key string
    A game property key
    value string
    A game property value.
    key str
    A game property key
    value str
    A game property value.
    key String
    A game property key
    value String
    A game property value.

    Import

    GameLift Matchmaking Configurations can be imported using the ID, e.g.,

     $ pulumi import aws:gamelift/matchmakingConfiguration:MatchmakingConfiguration example <matchmakingconfiguration-id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v5.43.0 (Older version)
    published on Tuesday, Mar 10, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.