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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.gamelift.getMatchmakingConfiguration

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

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

    Using getMatchmakingConfiguration

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getMatchmakingConfiguration(args: GetMatchmakingConfigurationArgs, opts?: InvokeOptions): Promise<GetMatchmakingConfigurationResult>
function getMatchmakingConfigurationOutput(args: GetMatchmakingConfigurationOutputArgs, opts?: InvokeOptions): Output<GetMatchmakingConfigurationResult>
    def get_matchmaking_configuration(name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetMatchmakingConfigurationResult
def get_matchmaking_configuration_output(name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetMatchmakingConfigurationResult]
    func LookupMatchmakingConfiguration(ctx *Context, args *LookupMatchmakingConfigurationArgs, opts ...InvokeOption) (*LookupMatchmakingConfigurationResult, error)
func LookupMatchmakingConfigurationOutput(ctx *Context, args *LookupMatchmakingConfigurationOutputArgs, opts ...InvokeOption) LookupMatchmakingConfigurationResultOutput

    > Note: This function is named LookupMatchmakingConfiguration in the Go SDK.

    public static class GetMatchmakingConfiguration 
{
    public static Task<GetMatchmakingConfigurationResult> InvokeAsync(GetMatchmakingConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetMatchmakingConfigurationResult> Invoke(GetMatchmakingConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMatchmakingConfigurationResult> getMatchmakingConfiguration(GetMatchmakingConfigurationArgs args, InvokeOptions options)
public static Output<GetMatchmakingConfigurationResult> getMatchmakingConfiguration(GetMatchmakingConfigurationArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:gamelift:getMatchmakingConfiguration
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    A unique identifier for the matchmaking configuration.
    Name string
    A unique identifier for the matchmaking configuration.
    name String
    A unique identifier for the matchmaking configuration.
    name string
    A unique identifier for the matchmaking configuration.
    name str
    A unique identifier for the matchmaking configuration.
    name String
    A unique identifier for the matchmaking configuration.

    getMatchmakingConfiguration Result

    The following output properties are available:

    AcceptanceRequired bool
    A flag that indicates whether a match that was created with this configuration must be accepted by the 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
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
    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.Outputs.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.
    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
    The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
    RuleSetName string
    A unique identifier for the matchmaking rule set to use with this configuration.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    AcceptanceRequired bool
    A flag that indicates whether a match that was created with this configuration must be accepted by the 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
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
    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.
    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
    The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
    RuleSetName string
    A unique identifier for the matchmaking rule set to use with this configuration.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    acceptanceRequired Boolean
    A flag that indicates whether a match that was created with this configuration must be accepted by the 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
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
    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.
    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
    The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
    ruleSetName String
    A unique identifier for the matchmaking rule set to use with this configuration.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    acceptanceRequired boolean
    A flag that indicates whether a match that was created with this configuration must be accepted by the 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
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
    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.
    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
    The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
    ruleSetName string
    A unique identifier for the matchmaking rule set to use with this configuration.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    acceptance_required bool
    A flag that indicates whether a match that was created with this configuration must be accepted by the 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
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
    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[MatchmakingConfigurationGameProperty]
    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.
    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
    The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
    rule_set_name str
    A unique identifier for the matchmaking rule set to use with this configuration.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    acceptanceRequired Boolean
    A flag that indicates whether a match that was created with this configuration must be accepted by the 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
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
    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.
    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
    The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
    ruleSetName String
    A unique identifier for the matchmaking rule set to use with this configuration.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    MatchmakingConfigurationBackfillMode

    MatchmakingConfigurationFlexMatchMode

    MatchmakingConfigurationGameProperty

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

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native