MatchmakingConfigurationProps

class aws_cdk.aws_gamelift_alpha.MatchmakingConfigurationProps(*, matchmaking_configuration_name, rule_set, acceptance_timeout=None, custom_event_data=None, description=None, notification_target=None, request_timeout=None, require_acceptance=None)

Bases: object

(experimental) Properties for a new Gamelift matchmaking configuration.

Parameters:

matchmaking_configuration_name (str) – (experimental) A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.
rule_set (IMatchmakingRuleSet) – (experimental) A matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same Region.
acceptance_timeout (Optional[Duration]) – (experimental) The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. Default: 300 seconds
custom_event_data (Optional[str]) – (experimental) Information to add to all events related to the matchmaking configuration. Default: no custom data added to events
description (Optional[str]) – (experimental) A human-readable description of the matchmaking configuration. Default: no description is provided
notification_target (Optional[ITopic]) – (experimental) An SNS topic ARN that is set up to receive matchmaking notifications. Default: no notification target
request_timeout (Optional[Duration]) – (experimental) The maximum duration, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed. Default: 300 seconds
require_acceptance (Optional[bool]) – (experimental) A flag that determines whether a match that was created with this configuration must be accepted by the matched players. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance. Default: Acceptance is not required

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_gamelift_alpha as gamelift_alpha
import aws_cdk as cdk
from aws_cdk import aws_sns as sns

# matchmaking_rule_set: gamelift_alpha.MatchmakingRuleSet
# topic: sns.Topic

matchmaking_configuration_props = gamelift_alpha.MatchmakingConfigurationProps(
    matchmaking_configuration_name="matchmakingConfigurationName",
    rule_set=matchmaking_rule_set,

    # the properties below are optional
    acceptance_timeout=cdk.Duration.minutes(30),
    custom_event_data="customEventData",
    description="description",
    notification_target=topic,
    request_timeout=cdk.Duration.minutes(30),
    require_acceptance=False
)

Attributes

acceptance_timeout

(experimental) The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

Default:: 300 seconds
Stability:: experimental

custom_event_data

(experimental) Information to add to all events related to the matchmaking configuration.

Default:: no custom data added to events
Stability:: experimental

description

(experimental) A human-readable description of the matchmaking configuration.

Default:: no description is provided
Stability:: experimental

matchmaking_configuration_name

(experimental) A unique identifier for the matchmaking configuration.

This name is used to identify the configuration associated with a matchmaking request or ticket.

Stability:: experimental

notification_target

(experimental) An SNS topic ARN that is set up to receive matchmaking notifications.

Default:: no notification target
See:: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html
Stability:: experimental

request_timeout

(experimental) The maximum duration, that a matchmaking ticket can remain in process before timing out.

Requests that fail due to timing out can be resubmitted as needed.

Default:: 300 seconds
Stability:: experimental

require_acceptance

(experimental) A flag that determines whether a match that was created with this configuration must be accepted by the matched players.

With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

Default:: Acceptance is not required
Stability:: experimental

rule_set

(experimental) A matchmaking rule set to use with this configuration.

A matchmaking configuration can only use rule sets that are defined in the same Region.

Stability:: experimental