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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.104.0 published on Tuesday, Apr 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.gamelift.MatchmakingConfiguration

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.104.0 published on Tuesday, Apr 30, 2024 by Pulumi
pulumi/pulumi-aws-native

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

    Create MatchmakingConfiguration Resource

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

    Constructor syntax

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

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

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

    Parameters

    name 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.

    Example

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

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const matchmakingConfigurationResource = new aws_native.gamelift.MatchmakingConfiguration("matchmakingConfigurationResource", {
    acceptanceRequired: false,
    ruleSetName: "string",
    requestTimeoutSeconds: 0,
    gameProperties: [{
        key: "string",
        value: "string",
    }],
    gameSessionQueueArns: ["string"],
    customEventData: "string",
    description: "string",
    flexMatchMode: aws_native.gamelift.MatchmakingConfigurationFlexMatchMode.Standalone,
    backfillMode: aws_native.gamelift.MatchmakingConfigurationBackfillMode.Automatic,
    gameSessionData: "string",
    creationTime: "string",
    name: "string",
    notificationTarget: "string",
    additionalPlayerCount: 0,
    ruleSetArn: "string",
    acceptanceTimeoutSeconds: 0,
    tags: [{
        key: "string",
        value: "string",
    }],
});

    Coming soon!

    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:

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

    Outputs

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

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

    Supporting Types

    MatchmakingConfigurationBackfillMode, MatchmakingConfigurationBackfillModeArgs

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

    MatchmakingConfigurationFlexMatchMode, MatchmakingConfigurationFlexMatchModeArgs

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

    MatchmakingConfigurationGameProperty, MatchmakingConfigurationGamePropertyArgs

    Key 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, TagArgs

    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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.104.0 published on Tuesday, Apr 30, 2024 by Pulumi
    pulumi/pulumi-aws-native