Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. gamelift
  5. MatchmakingConfiguration

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.gamelift.MatchmakingConfiguration

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a GameLift Alias resource.

    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

    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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)
    Resource lookup is not supported in YAML
    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws