GameLiftMatchmakingEvent

class aws_cdk.mixins_preview.aws_gamelift.events.GameLiftMatchmakingEvent

Bases: object

(experimental) EventBridge event pattern for aws.gamelift@GameLiftMatchmakingEvent.

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.
from aws_cdk.mixins_preview.aws_gamelift import events as gamelift_events

game_lift_matchmaking_event = gamelift_events.GameLiftMatchmakingEvent()

Stability:: experimental

Static Methods

classmethod game_lift_matchmaking_event_pattern(*, acceptance_required=None, acceptance_timeout=None, custom_event_data=None, estimated_wait_millis=None, event_metadata=None, game_session_info=None, match_id=None, message=None, reason=None, rule_evaluation_metrics=None, tickets=None, type=None)

(experimental) EventBridge event pattern for GameLift Matchmaking Event.

Parameters:

acceptance_required (Optional[Sequence[str]]) – (experimental) acceptanceRequired property. Specify an array of string values to match this event if the actual value of acceptanceRequired is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
acceptance_timeout (Optional[Sequence[str]]) – (experimental) acceptanceTimeout property. Specify an array of string values to match this event if the actual value of acceptanceTimeout is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
custom_event_data (Optional[Sequence[str]]) – (experimental) customEventData property. Specify an array of string values to match this event if the actual value of customEventData is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
estimated_wait_millis (Optional[Sequence[str]]) – (experimental) estimatedWaitMillis property. Specify an array of string values to match this event if the actual value of estimatedWaitMillis is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
game_session_info (Union[GameSessionInfo, Dict[str, Any], None]) – (experimental) gameSessionInfo property. Specify an array of string values to match this event if the actual value of gameSessionInfo is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
match_id (Optional[Sequence[str]]) – (experimental) matchId property. Specify an array of string values to match this event if the actual value of matchId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
message (Optional[Sequence[str]]) – (experimental) message property. Specify an array of string values to match this event if the actual value of message is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
reason (Optional[Sequence[str]]) – (experimental) reason property. Specify an array of string values to match this event if the actual value of reason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
rule_evaluation_metrics (Optional[Sequence[Union[RuleEvaluationMetrics, Dict[str, Any]]]]) – (experimental) ruleEvaluationMetrics property. Specify an array of string values to match this event if the actual value of ruleEvaluationMetrics is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
tickets (Optional[Sequence[Union[Ticket, Dict[str, Any]]]]) – (experimental) tickets property. Specify an array of string values to match this event if the actual value of tickets is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
type (Optional[Sequence[str]]) – (experimental) type property. Specify an array of string values to match this event if the actual value of type is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

GameLiftMatchmakingEventProps

class GameLiftMatchmakingEvent.GameLiftMatchmakingEventProps(*, acceptance_required=None, acceptance_timeout=None, custom_event_data=None, estimated_wait_millis=None, event_metadata=None, game_session_info=None, match_id=None, message=None, reason=None, rule_evaluation_metrics=None, tickets=None, type=None)

Bases: object

(experimental) Props type for aws.gamelift@GameLiftMatchmakingEvent event.

Parameters:

acceptance_required (Optional[Sequence[str]]) – (experimental) acceptanceRequired property. Specify an array of string values to match this event if the actual value of acceptanceRequired is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
acceptance_timeout (Optional[Sequence[str]]) – (experimental) acceptanceTimeout property. Specify an array of string values to match this event if the actual value of acceptanceTimeout is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
custom_event_data (Optional[Sequence[str]]) – (experimental) customEventData property. Specify an array of string values to match this event if the actual value of customEventData is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
estimated_wait_millis (Optional[Sequence[str]]) – (experimental) estimatedWaitMillis property. Specify an array of string values to match this event if the actual value of estimatedWaitMillis is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
game_session_info (Union[GameSessionInfo, Dict[str, Any], None]) – (experimental) gameSessionInfo property. Specify an array of string values to match this event if the actual value of gameSessionInfo is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
match_id (Optional[Sequence[str]]) – (experimental) matchId property. Specify an array of string values to match this event if the actual value of matchId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
message (Optional[Sequence[str]]) – (experimental) message property. Specify an array of string values to match this event if the actual value of message is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
reason (Optional[Sequence[str]]) – (experimental) reason property. Specify an array of string values to match this event if the actual value of reason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
rule_evaluation_metrics (Optional[Sequence[Union[RuleEvaluationMetrics, Dict[str, Any]]]]) – (experimental) ruleEvaluationMetrics property. Specify an array of string values to match this event if the actual value of ruleEvaluationMetrics is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
tickets (Optional[Sequence[Union[Ticket, Dict[str, Any]]]]) – (experimental) tickets property. Specify an array of string values to match this event if the actual value of tickets is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
type (Optional[Sequence[str]]) – (experimental) type property. Specify an array of string values to match this event if the actual value of type is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import AWSEventMetadataProps
# 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 events as gamelift_events

game_lift_matchmaking_event_props = gamelift_events.GameLiftMatchmakingEvent.GameLiftMatchmakingEventProps(
    acceptance_required=["acceptanceRequired"],
    acceptance_timeout=["acceptanceTimeout"],
    custom_event_data=["customEventData"],
    estimated_wait_millis=["estimatedWaitMillis"],
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    game_session_info=gamelift_events.GameLiftMatchmakingEvent.GameSessionInfo(
        game_session_arn=["gameSessionArn"],
        ip_address=["ipAddress"],
        players=[gamelift_events.GameLiftMatchmakingEvent.GameSessionInfoItem(
            player_id=["playerId"],
            team=["team"]
        )],
        port=["port"]
    ),
    match_id=["matchId"],
    message=["message"],
    reason=["reason"],
    rule_evaluation_metrics=[gamelift_events.GameLiftMatchmakingEvent.RuleEvaluationMetrics(
        failed_count=["failedCount"],
        passed_count=["passedCount"],
        rule_name=["ruleName"]
    )],
    tickets=[gamelift_events.GameLiftMatchmakingEvent.Ticket(
        players=[gamelift_events.GameLiftMatchmakingEvent.GameSessionInfoItem(
            player_id=["playerId"],
            team=["team"]
        )],
        start_time=["startTime"],
        ticket_id=["ticketId"]
    )],
    type=["type"]
)

Attributes

acceptance_required

(experimental) acceptanceRequired property.

Specify an array of string values to match this event if the actual value of acceptanceRequired is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

acceptance_timeout

(experimental) acceptanceTimeout property.

Specify an array of string values to match this event if the actual value of acceptanceTimeout is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

custom_event_data

(experimental) customEventData property.

Specify an array of string values to match this event if the actual value of customEventData is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

estimated_wait_millis

(experimental) estimatedWaitMillis property.

Specify an array of string values to match this event if the actual value of estimatedWaitMillis is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

game_session_info

(experimental) gameSessionInfo property.

Specify an array of string values to match this event if the actual value of gameSessionInfo is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

match_id

(experimental) matchId property.

Specify an array of string values to match this event if the actual value of matchId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

message

(experimental) message property.

Specify an array of string values to match this event if the actual value of message is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

reason

(experimental) reason property.

Specify an array of string values to match this event if the actual value of reason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

rule_evaluation_metrics

(experimental) ruleEvaluationMetrics property.

Specify an array of string values to match this event if the actual value of ruleEvaluationMetrics is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

tickets

(experimental) tickets property.

Specify an array of string values to match this event if the actual value of tickets is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

type

(experimental) type property.

Specify an array of string values to match this event if the actual value of type is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

GameSessionInfo

class GameLiftMatchmakingEvent.GameSessionInfo(*, game_session_arn=None, ip_address=None, players=None, port=None)

Bases: object

(experimental) Type definition for GameSessionInfo.

Parameters:

game_session_arn (Optional[Sequence[str]]) – (experimental) gameSessionArn property. Specify an array of string values to match this event if the actual value of gameSessionArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
ip_address (Optional[Sequence[str]]) – (experimental) ipAddress property. Specify an array of string values to match this event if the actual value of ipAddress is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
players (Optional[Sequence[Union[GameSessionInfoItem, Dict[str, Any]]]]) – (experimental) players property. Specify an array of string values to match this event if the actual value of players is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
port (Optional[Sequence[str]]) – (experimental) port property. Specify an array of string values to match this event if the actual value of port is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

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.
from aws_cdk.mixins_preview.aws_gamelift import events as gamelift_events

game_session_info = gamelift_events.GameLiftMatchmakingEvent.GameSessionInfo(
    game_session_arn=["gameSessionArn"],
    ip_address=["ipAddress"],
    players=[gamelift_events.GameLiftMatchmakingEvent.GameSessionInfoItem(
        player_id=["playerId"],
        team=["team"]
    )],
    port=["port"]
)

Attributes

game_session_arn

(experimental) gameSessionArn property.

Specify an array of string values to match this event if the actual value of gameSessionArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ip_address

(experimental) ipAddress property.

Specify an array of string values to match this event if the actual value of ipAddress is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

players

(experimental) players property.

Specify an array of string values to match this event if the actual value of players is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

port

(experimental) port property.

Specify an array of string values to match this event if the actual value of port is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

GameSessionInfoItem

class GameLiftMatchmakingEvent.GameSessionInfoItem(*, player_id=None, team=None)

Bases: object

(experimental) Type definition for GameSessionInfoItem.

Parameters:

player_id (Optional[Sequence[str]]) – (experimental) playerId property. Specify an array of string values to match this event if the actual value of playerId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
team (Optional[Sequence[str]]) – (experimental) team property. Specify an array of string values to match this event if the actual value of team is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

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.
from aws_cdk.mixins_preview.aws_gamelift import events as gamelift_events

game_session_info_item = gamelift_events.GameLiftMatchmakingEvent.GameSessionInfoItem(
    player_id=["playerId"],
    team=["team"]
)

Attributes

player_id

(experimental) playerId property.

Specify an array of string values to match this event if the actual value of playerId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

team

(experimental) team property.

Specify an array of string values to match this event if the actual value of team is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

RuleEvaluationMetrics

class GameLiftMatchmakingEvent.RuleEvaluationMetrics(*, failed_count=None, passed_count=None, rule_name=None)

Bases: object

(experimental) Type definition for RuleEvaluationMetrics.

Parameters:

failed_count (Optional[Sequence[str]]) – (experimental) failedCount property. Specify an array of string values to match this event if the actual value of failedCount is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
passed_count (Optional[Sequence[str]]) – (experimental) passedCount property. Specify an array of string values to match this event if the actual value of passedCount is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
rule_name (Optional[Sequence[str]]) – (experimental) ruleName property. Specify an array of string values to match this event if the actual value of ruleName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

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.
from aws_cdk.mixins_preview.aws_gamelift import events as gamelift_events

rule_evaluation_metrics = gamelift_events.GameLiftMatchmakingEvent.RuleEvaluationMetrics(
    failed_count=["failedCount"],
    passed_count=["passedCount"],
    rule_name=["ruleName"]
)

Attributes

failed_count

(experimental) failedCount property.

Specify an array of string values to match this event if the actual value of failedCount is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

passed_count

(experimental) passedCount property.

Specify an array of string values to match this event if the actual value of passedCount is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

rule_name

(experimental) ruleName property.

Specify an array of string values to match this event if the actual value of ruleName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

Ticket

class GameLiftMatchmakingEvent.Ticket(*, players=None, start_time=None, ticket_id=None)

Bases: object

(experimental) Type definition for Ticket.

Parameters:

players (Optional[Sequence[Union[GameSessionInfoItem, Dict[str, Any]]]]) – (experimental) players property. Specify an array of string values to match this event if the actual value of players is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
start_time (Optional[Sequence[str]]) – (experimental) startTime property. Specify an array of string values to match this event if the actual value of startTime is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
ticket_id (Optional[Sequence[str]]) – (experimental) ticketId property. Specify an array of string values to match this event if the actual value of ticketId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

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.
from aws_cdk.mixins_preview.aws_gamelift import events as gamelift_events

ticket = gamelift_events.GameLiftMatchmakingEvent.Ticket(
    players=[gamelift_events.GameLiftMatchmakingEvent.GameSessionInfoItem(
        player_id=["playerId"],
        team=["team"]
    )],
    start_time=["startTime"],
    ticket_id=["ticketId"]
)

Attributes

players

(experimental) players property.

Specify an array of string values to match this event if the actual value of players is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

start_time

(experimental) startTime property.

Specify an array of string values to match this event if the actual value of startTime is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ticket_id

(experimental) ticketId property.

Specify an array of string values to match this event if the actual value of ticketId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental