CfnGameSessionQueueProps

class aws_cdk.aws_gamelift.CfnGameSessionQueueProps(*, name, custom_event_data=None, destinations=None, filter_configuration=None, notification_target=None, player_latency_policies=None, priority_configuration=None, tags=None, timeout_in_seconds=None)

Bases: object

Properties for defining a CfnGameSessionQueue.

Parameters
  • name (str) – A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

  • custom_event_data (Optional[str]) – Information to be added to all events that are related to this game session queue.

  • destinations (Union[IResolvable, Sequence[Union[IResolvable, DestinationProperty]], None]) – A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.

  • filter_configuration (Union[IResolvable, FilterConfigurationProperty, None]) – A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as us-west-2 . If this parameter is not set, game sessions can be placed in any queue location.

  • notification_target (Optional[str]) – An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement .

  • player_latency_policies (Union[IResolvable, Sequence[Union[IResolvable, PlayerLatencyPolicyProperty]], None]) – A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.

  • priority_configuration (Union[IResolvable, PriorityConfigurationProperty, None]) – Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

  • tags (Optional[Sequence[CfnTag]]) – A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

  • timeout_in_seconds (Union[int, float, None]) – The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html

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 as gamelift

cfn_game_session_queue_props = gamelift.CfnGameSessionQueueProps(
    name="name",

    # the properties below are optional
    custom_event_data="customEventData",
    destinations=[gamelift.CfnGameSessionQueue.DestinationProperty(
        destination_arn="destinationArn"
    )],
    filter_configuration=gamelift.CfnGameSessionQueue.FilterConfigurationProperty(
        allowed_locations=["allowedLocations"]
    ),
    notification_target="notificationTarget",
    player_latency_policies=[gamelift.CfnGameSessionQueue.PlayerLatencyPolicyProperty(
        maximum_individual_player_latency_milliseconds=123,
        policy_duration_seconds=123
    )],
    priority_configuration=gamelift.CfnGameSessionQueue.PriorityConfigurationProperty(
        location_order=["locationOrder"],
        priority_order=["priorityOrder"]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    timeout_in_seconds=123
)

Attributes

custom_event_data

Information to be added to all events that are related to this game session queue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-customeventdata

Return type

Optional[str]

destinations

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.

Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-destinations

Return type

Union[IResolvable, List[Union[IResolvable, DestinationProperty]], None]

filter_configuration

A list of locations where a queue is allowed to place new game sessions.

Locations are specified in the form of AWS Region codes, such as us-west-2 . If this parameter is not set, game sessions can be placed in any queue location.

Link

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

Return type

Union[IResolvable, FilterConfigurationProperty, None]

name

A descriptive label that is associated with game session queue.

Queue names must be unique within each Region.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-name

Return type

str

notification_target

An SNS topic ARN that is set up to receive game session placement notifications.

See Setting up notifications for game session placement .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-notificationtarget

Return type

Optional[str]

player_latency_policies

A set of policies that act as a sliding cap on player latency.

FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-playerlatencypolicies

Return type

Union[IResolvable, List[Union[IResolvable, PlayerLatencyPolicyProperty]], None]

priority_configuration

Custom settings to use when prioritizing destinations and locations for game session placements.

This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

Link

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

Return type

Union[IResolvable, PriorityConfigurationProperty, None]

tags

A list of labels to assign to the new game session queue resource.

Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-tags

Return type

Optional[List[CfnTag]]

timeout_in_seconds

The maximum time, in seconds, that a new game session placement request remains in the queue.

When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-timeoutinseconds

Return type

Union[int, float, None]