CfnMatchmakingConfigurationPropsMixin

class aws_cdk.mixins_preview.aws_gamelift.mixins.CfnMatchmakingConfigurationPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::GameLift::MatchmakingConfiguration resource defines a new matchmaking configuration for use with FlexMatch.

Whether you’re using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you’re using GameLift hosting, it also defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes that are consistent with that configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html
CloudformationResource:: AWS::GameLift::MatchmakingConfiguration
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_gamelift import mixins as gamelift_mixins

cfn_matchmaking_configuration_props_mixin = gamelift_mixins.CfnMatchmakingConfigurationPropsMixin(gamelift_mixins.CfnMatchmakingConfigurationMixinProps(
    acceptance_required=False,
    acceptance_timeout_seconds=123,
    additional_player_count=123,
    backfill_mode="backfillMode",
    creation_time="creationTime",
    custom_event_data="customEventData",
    description="description",
    flex_match_mode="flexMatchMode",
    game_properties=[gamelift_mixins.CfnMatchmakingConfigurationPropsMixin.GamePropertyProperty(
        key="key",
        value="value"
    )],
    game_session_data="gameSessionData",
    game_session_queue_arns=["gameSessionQueueArns"],
    name="name",
    notification_target="notificationTarget",
    request_timeout_seconds=123,
    rule_set_arn="ruleSetArn",
    rule_set_name="ruleSetName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::GameLift::MatchmakingConfiguration.

Parameters:

props (Union[CfnMatchmakingConfigurationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['acceptanceRequired', 'acceptanceTimeoutSeconds', 'additionalPlayerCount', 'backfillMode', 'creationTime', 'customEventData', 'description', 'flexMatchMode', 'gameProperties', 'gameSessionData', 'gameSessionQueueArns', 'name', 'notificationTarget', 'requestTimeoutSeconds', 'ruleSetArn', 'ruleSetName', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

GamePropertyProperty

class CfnMatchmakingConfigurationPropsMixin.GamePropertyProperty(*, key=None, value=None)

Bases: object

This key-value pair can store custom data about a game session.

For example, you might use a GameProperty to track a game session’s map, level of difficulty, or remaining time. The difficulty level could be specified like this: {"Key": "difficulty", "Value":"Novice"} .

You can set game properties when creating a game session. You can also modify game properties of an active game session. When searching for game sessions, you can filter on game property keys and values. You can’t delete game properties from a game session.

For examples of working with game properties, see Create a game session with properties .

Parameters:

key (Optional[str]) – The game property identifier.
value (Optional[str]) – The game property value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_gamelift import mixins as gamelift_mixins

game_property_property = gamelift_mixins.CfnMatchmakingConfigurationPropsMixin.GamePropertyProperty(
    key="key",
    value="value"
)

Attributes

key

The game property identifier.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html#cfn-gamelift-matchmakingconfiguration-gameproperty-key

value

The game property value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html#cfn-gamelift-matchmakingconfiguration-gameproperty-value