CfnGameSessionQueuePropsMixin

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

Bases: Mixin

The AWS::GameLift::GameSessionQueue resource creates a placement queue that processes requests for new game sessions.

A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server, then prompts the game server to start a new game session. Queues can have destinations (GameLift fleets or aliases), which determine where the queue can place new game sessions. A queue can have destinations with varied fleet type (Spot and On-Demand), instance type, and AWS Region .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html
CloudformationResource:: AWS::GameLift::GameSessionQueue
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_game_session_queue_props_mixin = gamelift_mixins.CfnGameSessionQueuePropsMixin(gamelift_mixins.CfnGameSessionQueueMixinProps(
    custom_event_data="customEventData",
    destinations=[gamelift_mixins.CfnGameSessionQueuePropsMixin.DestinationProperty(
        destination_arn="destinationArn"
    )],
    filter_configuration=gamelift_mixins.CfnGameSessionQueuePropsMixin.FilterConfigurationProperty(
        allowed_locations=["allowedLocations"]
    ),
    name="name",
    notification_target="notificationTarget",
    player_latency_policies=[gamelift_mixins.CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty(
        maximum_individual_player_latency_milliseconds=123,
        policy_duration_seconds=123
    )],
    priority_configuration=gamelift_mixins.CfnGameSessionQueuePropsMixin.PriorityConfigurationProperty(
        location_order=["locationOrder"],
        priority_order=["priorityOrder"]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    timeout_in_seconds=123
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnGameSessionQueueMixinProps, 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 = ['customEventData', 'destinations', 'filterConfiguration', 'name', 'notificationTarget', 'playerLatencyPolicies', 'priorityConfiguration', 'tags', 'timeoutInSeconds']

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

DestinationProperty

class CfnGameSessionQueuePropsMixin.DestinationProperty(*, destination_arn=None)

Bases: object

Parameters:: destination_arn (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-destination.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

destination_property = gamelift_mixins.CfnGameSessionQueuePropsMixin.DestinationProperty(
    destination_arn="destinationArn"
)

Attributes

destination_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-destination.html#cfn-gamelift-gamesessionqueue-destination-destinationarn

Type:: see

FilterConfigurationProperty

class CfnGameSessionQueuePropsMixin.FilterConfigurationProperty(*, allowed_locations=None)

Bases: object

A list of fleet locations where a game session queue can place new game sessions.

You can use a filter to temporarily turn off placements for specific locations. For queues that have multi-location fleets, you can use a filter configuration allow placement with some, but not all of these locations.

Parameters:: allowed_locations (Optional[Sequence[str]]) – A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2 .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-filterconfiguration.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

filter_configuration_property = gamelift_mixins.CfnGameSessionQueuePropsMixin.FilterConfigurationProperty(
    allowed_locations=["allowedLocations"]
)

Attributes

allowed_locations

A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-filterconfiguration.html#cfn-gamelift-gamesessionqueue-filterconfiguration-allowedlocations

GameSessionQueueDestinationProperty

class CfnGameSessionQueuePropsMixin.GameSessionQueueDestinationProperty(*, destination_arn=None)

Bases: object

A fleet or alias designated in a game session queue.

Queues fulfill requests for new game sessions by placing a new game session on any of the queue’s destinations.

Parameters:: destination_arn (Optional[str]) – The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-gamesessionqueuedestination.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_session_queue_destination_property = gamelift_mixins.CfnGameSessionQueuePropsMixin.GameSessionQueueDestinationProperty(
    destination_arn="destinationArn"
)

Attributes

destination_arn

The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias.

ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-gamesessionqueuedestination.html#cfn-gamelift-gamesessionqueue-gamesessionqueuedestination-destinationarn

PlayerLatencyPolicyProperty

class CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty(*, maximum_individual_player_latency_milliseconds=None, policy_duration_seconds=None)

Bases: object

The queue setting that determines the highest latency allowed for individual players when placing a game session.

When a latency policy is in force, a game session cannot be placed with any fleet in a Region where a player reports latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.

Parameters:

maximum_individual_player_latency_milliseconds (Union[int, float, None]) – The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
policy_duration_seconds (Union[int, float, None]) – The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.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

player_latency_policy_property = gamelift_mixins.CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty(
    maximum_individual_player_latency_milliseconds=123,
    policy_duration_seconds=123
)

Attributes

maximum_individual_player_latency_milliseconds

The maximum latency value that is allowed for any player, in milliseconds.

All policies must have a value set for this property.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html#cfn-gamelift-gamesessionqueue-playerlatencypolicy-maximumindividualplayerlatencymilliseconds

policy_duration_seconds

The length of time, in seconds, that the policy is enforced while placing a new game session.

A null value for this property means that the policy is enforced until the queue times out.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html#cfn-gamelift-gamesessionqueue-playerlatencypolicy-policydurationseconds

PriorityConfigurationProperty

class CfnGameSessionQueuePropsMixin.PriorityConfigurationProperty(*, location_order=None, priority_order=None)

Bases: object

Custom prioritization settings for use by a game session queue when placing new game sessions with available game servers.

When defined, this configuration replaces the default FleetIQ prioritization process, which is as follows:

If player latency data is included in a game session request, destinations and locations are prioritized first based on lowest average latency (1), then on lowest hosting cost (2), then on destination list order (3), and finally on location (alphabetical) (4). This approach ensures that the queue’s top priority is to place game sessions where average player latency is lowest, and–if latency is the same–where the hosting cost is less, etc.
If player latency data is not included, destinations and locations are prioritized first on destination list order (1), and then on location (alphabetical) (2). This approach ensures that the queue’s top priority is to place game sessions on the first destination fleet listed. If that fleet has multiple locations, the game session is placed on the first location (when listed alphabetically).

Changing the priority order will affect how game sessions are placed.

Parameters:

location_order (Optional[Sequence[str]]) – The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations can include AWS Region codes (such as us-west-2 ), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift Servers service locations.
priority_order (Optional[Sequence[str]]) – A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once. - LATENCY – Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request. - COST – Amazon GameLift Servers prioritizes queue destinations with the lowest current hosting costs. Cost is evaluated based on the destination’s location, instance type, and fleet type (Spot or On-Demand). - DESTINATION – Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration. - LOCATION – Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in LocationOrder .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-priorityconfiguration.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

priority_configuration_property = gamelift_mixins.CfnGameSessionQueuePropsMixin.PriorityConfigurationProperty(
    location_order=["locationOrder"],
    priority_order=["priorityOrder"]
)

Attributes

location_order

The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION .

Locations can include AWS Region codes (such as us-west-2 ), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift Servers service locations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-priorityconfiguration.html#cfn-gamelift-gamesessionqueue-priorityconfiguration-locationorder

priority_order

A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.

LATENCY – Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.
COST – Amazon GameLift Servers prioritizes queue destinations with the lowest current hosting costs. Cost is evaluated based on the destination’s location, instance type, and fleet type (Spot or On-Demand).
DESTINATION – Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration.
LOCATION – Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in LocationOrder .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-priorityconfiguration.html#cfn-gamelift-gamesessionqueue-priorityconfiguration-priorityorder