Skip to content
v2.278.0

CfnGameSessionQueueProps Struct ​

Properties for defining a CfnGameSessionQueue.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_gamelift as gamelift } from 'aws-cdk-lib';
const cfnGameSessionQueueProps: gamelift.CfnGameSessionQueueProps = {
  name: 'name',

  // the properties below are optional
  customEventData: 'customEventData',
  destinations: [{
    destinationArn: 'destinationArn',
  }],
  filterConfiguration: {
    allowedLocations: ['allowedLocations'],
  },
  logConfiguration: {
    deliveryDestinations: [{
      logDestination: 'logDestination',

      // the properties below are optional
      destinationArn: 'destinationArn',
    }],
  },
  notificationTarget: 'notificationTarget',
  playerLatencyPolicies: [{
    maximumIndividualPlayerLatencyMilliseconds: 123,
    policyDurationSeconds: 123,
  }],
  priorityConfiguration: {
    locationOrder: ['locationOrder'],
    priorityOrder: ['priorityOrder'],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  timeoutInSeconds: 123,
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import 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"]
    ),
    log_configuration=gamelift.CfnGameSessionQueue.LogConfigurationProperty(
        delivery_destinations=[gamelift.CfnGameSessionQueue.DeliveryDestinationProperty(
            log_destination="logDestination",

            # the properties below are optional
            destination_arn="destinationArn"
        )]
    ),
    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
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.gamelift.*;

CfnGameSessionQueueProps cfnGameSessionQueueProps = CfnGameSessionQueueProps.builder()
        .name("name")

        // the properties below are optional
        .customEventData("customEventData")
        .destinations(List.of(DestinationProperty.builder()
                .destinationArn("destinationArn")
                .build()))
        .filterConfiguration(FilterConfigurationProperty.builder()
                .allowedLocations(List.of("allowedLocations"))
                .build())
        .logConfiguration(LogConfigurationProperty.builder()
                .deliveryDestinations(List.of(DeliveryDestinationProperty.builder()
                        .logDestination("logDestination")

                        // the properties below are optional
                        .destinationArn("destinationArn")
                        .build()))
                .build())
        .notificationTarget("notificationTarget")
        .playerLatencyPolicies(List.of(PlayerLatencyPolicyProperty.builder()
                .maximumIndividualPlayerLatencyMilliseconds(123)
                .policyDurationSeconds(123)
                .build()))
        .priorityConfiguration(PriorityConfigurationProperty.builder()
                .locationOrder(List.of("locationOrder"))
                .priorityOrder(List.of("priorityOrder"))
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .timeoutInSeconds(123)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift;

var cfnGameSessionQueueProps = new CfnGameSessionQueueProps {
    Name = "name",

    // the properties below are optional
    CustomEventData = "customEventData",
    Destinations = new [] { new DestinationProperty {
        DestinationArn = "destinationArn"
    } },
    FilterConfiguration = new FilterConfigurationProperty {
        AllowedLocations = new [] { "allowedLocations" }
    },
    LogConfiguration = new LogConfigurationProperty {
        DeliveryDestinations = new [] { new DeliveryDestinationProperty {
            LogDestination = "logDestination",

            // the properties below are optional
            DestinationArn = "destinationArn"
        } }
    },
    NotificationTarget = "notificationTarget",
    PlayerLatencyPolicies = new [] { new PlayerLatencyPolicyProperty {
        MaximumIndividualPlayerLatencyMilliseconds = 123,
        PolicyDurationSeconds = 123
    } },
    PriorityConfiguration = new PriorityConfigurationProperty {
        LocationOrder = new [] { "locationOrder" },
        PriorityOrder = new [] { "priorityOrder" }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TimeoutInSeconds = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnGameSessionQueueProps := &CfnGameSessionQueueProps{
	Name: jsii.String("name"),

	// the properties below are optional
	CustomEventData: jsii.String("customEventData"),
	Destinations: []interface{}{
		&DestinationProperty{
			DestinationArn: jsii.String("destinationArn"),
		},
	},
	FilterConfiguration: &FilterConfigurationProperty{
		AllowedLocations: []*string{
			jsii.String("allowedLocations"),
		},
	},
	LogConfiguration: &LogConfigurationProperty{
		DeliveryDestinations: []interface{}{
			&DeliveryDestinationProperty{
				LogDestination: jsii.String("logDestination"),

				// the properties below are optional
				DestinationArn: jsii.String("destinationArn"),
			},
		},
	},
	NotificationTarget: jsii.String("notificationTarget"),
	PlayerLatencyPolicies: []interface{}{
		&PlayerLatencyPolicyProperty{
			MaximumIndividualPlayerLatencyMilliseconds: jsii.Number(123),
			PolicyDurationSeconds: jsii.Number(123),
		},
	},
	PriorityConfiguration: &PriorityConfigurationProperty{
		LocationOrder: []*string{
			jsii.String("locationOrder"),
		},
		PriorityOrder: []*string{
			jsii.String("priorityOrder"),
		},
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	TimeoutInSeconds: jsii.Number(123),
}

Properties ​

customEventDataoptionalstringcustom_event_dataoptionalstrcustomEventDataoptionalStringCustomEventDataoptionalstringCustomEventDataoptional*string #
Information to be added to all events that are related to this game session queue.
destinationsoptionalIResolvable | IResolvable | CfnGameSessionQueue.DestinationProperty[]destinationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DestinationProperty]]]destinationsoptionalIResolvableDestinationsoptionalIResolvableDestinationsoptionalinterface{} #
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.

filterConfigurationoptionalIResolvable | CfnGameSessionQueue.FilterConfigurationPropertyfilter_configurationoptionaltyping.Union[IResolvable, FilterConfigurationProperty]filterConfigurationoptionalIResolvableFilterConfigurationoptionalIResolvableFilterConfigurationoptionalinterface{} #
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.

logConfigurationoptionalIResolvable | CfnGameSessionQueue.LogConfigurationPropertylog_configurationoptionaltyping.Union[IResolvable, LogConfigurationProperty]logConfigurationoptionalIResolvableLogConfigurationoptionalIResolvableLogConfigurationoptionalinterface{} #
A policy that determines where a game session queue's placement logs are delivered.
namestringnamestrnameStringNamestringName*string required #
A descriptive label that is associated with game session queue.

Queue names must be unique within each Region.

notificationTargetoptionalstringnotification_targetoptionalstrnotificationTargetoptionalStringNotificationTargetoptionalstringNotificationTargetoptional*string #
An SNS topic ARN that is set up to receive game session placement notifications.
playerLatencyPoliciesoptionalIResolvable | IResolvable | CfnGameSessionQueue.PlayerLatencyPolicyProperty[]player_latency_policiesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PlayerLatencyPolicyProperty]]]playerLatencyPoliciesoptionalIResolvablePlayerLatencyPoliciesoptionalIResolvablePlayerLatencyPoliciesoptionalinterface{} #
A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests.

Use multiple policies to gradually relax the cap over time if Amazon GameLift Servers can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value.

priorityConfigurationoptionalIResolvable | CfnGameSessionQueue.PriorityConfigurationPropertypriority_configurationoptionaltyping.Union[IResolvable, PriorityConfigurationProperty]priorityConfigurationoptionalIResolvablePriorityConfigurationoptionalIResolvablePriorityConfigurationoptionalinterface{} #
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.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
A list of labels to assign to the new game session queue resource.
notes

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.

timeoutInSecondsoptionalnumbertimeout_in_secondsoptionalint | floattimeoutInSecondsoptionalNumberTimeoutInSecondsoptionaldoubleTimeoutInSecondsoptional*float64 #
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. If you don't specify a request timeout, the queue uses a default value.