GameLiftQueuePlacementEvent

class aws_cdk.mixins_preview.aws_gamelift.events.GameLiftQueuePlacementEvent

Bases: object

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

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_queue_placement_event = gamelift_events.GameLiftQueuePlacementEvent()
Stability:

experimental

Static Methods

classmethod game_lift_queue_placement_event_pattern(*, dns_name=None, end_time=None, event_metadata=None, game_session_arn=None, game_session_region=None, ip_address=None, placed_player_sessions=None, placement_id=None, port=None, start_time=None, type=None)

(experimental) EventBridge event pattern for GameLift Queue Placement Event.

Parameters:
  • dns_name (Optional[Sequence[str]]) – (experimental) dnsName property. Specify an array of string values to match this event if the actual value of dnsName 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

  • end_time (Optional[Sequence[str]]) – (experimental) endTime property. Specify an array of string values to match this event if the actual value of endTime 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_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

  • game_session_region (Optional[Sequence[str]]) – (experimental) gameSessionRegion property. Specify an array of string values to match this event if the actual value of gameSessionRegion 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

  • placed_player_sessions (Optional[Sequence[Union[GameLiftQueuePlacementEventItem, Dict[str, Any]]]]) – (experimental) placedPlayerSessions property. Specify an array of string values to match this event if the actual value of placedPlayerSessions 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

  • placement_id (Optional[Sequence[str]]) – (experimental) placementId property. Specify an array of string values to match this event if the actual value of placementId 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

  • 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

  • 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

GameLiftQueuePlacementEventItem

class GameLiftQueuePlacementEvent.GameLiftQueuePlacementEventItem(*, player_id=None, player_session_id=None)

Bases: object

(experimental) Type definition for GameLiftQueuePlacementEventItem.

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

  • player_session_id (Optional[Sequence[str]]) – (experimental) playerSessionId property. Specify an array of string values to match this event if the actual value of playerSessionId 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_lift_queue_placement_event_item = gamelift_events.GameLiftQueuePlacementEvent.GameLiftQueuePlacementEventItem(
    player_id=["playerId"],
    player_session_id=["playerSessionId"]
)

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

player_session_id

(experimental) playerSessionId property.

Specify an array of string values to match this event if the actual value of playerSessionId 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

GameLiftQueuePlacementEventProps

class GameLiftQueuePlacementEvent.GameLiftQueuePlacementEventProps(*, dns_name=None, end_time=None, event_metadata=None, game_session_arn=None, game_session_region=None, ip_address=None, placed_player_sessions=None, placement_id=None, port=None, start_time=None, type=None)

Bases: object

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

Parameters:
  • dns_name (Optional[Sequence[str]]) – (experimental) dnsName property. Specify an array of string values to match this event if the actual value of dnsName 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

  • end_time (Optional[Sequence[str]]) – (experimental) endTime property. Specify an array of string values to match this event if the actual value of endTime 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_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

  • game_session_region (Optional[Sequence[str]]) – (experimental) gameSessionRegion property. Specify an array of string values to match this event if the actual value of gameSessionRegion 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

  • placed_player_sessions (Optional[Sequence[Union[GameLiftQueuePlacementEventItem, Dict[str, Any]]]]) – (experimental) placedPlayerSessions property. Specify an array of string values to match this event if the actual value of placedPlayerSessions 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

  • placement_id (Optional[Sequence[str]]) – (experimental) placementId property. Specify an array of string values to match this event if the actual value of placementId 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

  • 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

  • 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_queue_placement_event_props = gamelift_events.GameLiftQueuePlacementEvent.GameLiftQueuePlacementEventProps(
    dns_name=["dnsName"],
    end_time=["endTime"],
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    game_session_arn=["gameSessionArn"],
    game_session_region=["gameSessionRegion"],
    ip_address=["ipAddress"],
    placed_player_sessions=[gamelift_events.GameLiftQueuePlacementEvent.GameLiftQueuePlacementEventItem(
        player_id=["playerId"],
        player_session_id=["playerSessionId"]
    )],
    placement_id=["placementId"],
    port=["port"],
    start_time=["startTime"],
    type=["type"]
)

Attributes

dns_name

(experimental) dnsName property.

Specify an array of string values to match this event if the actual value of dnsName 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

end_time

(experimental) endTime property.

Specify an array of string values to match this event if the actual value of endTime 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_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

game_session_region

(experimental) gameSessionRegion property.

Specify an array of string values to match this event if the actual value of gameSessionRegion 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

placed_player_sessions

(experimental) placedPlayerSessions property.

Specify an array of string values to match this event if the actual value of placedPlayerSessions 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

placement_id

(experimental) placementId property.

Specify an array of string values to match this event if the actual value of placementId 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

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

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