software.amazon.awscdk.services.gamelift

Interface CfnGameSessionQueueProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGameSessionQueueProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:09.358Z")
 @Stability(value=Stable)
public interface CfnGameSessionQueueProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnGameSessionQueue`.

Example:

 // 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())
         .notificationTarget("notificationTarget")
         .playerLatencyPolicies(List.of(PlayerLatencyPolicyProperty.builder()
                 .maximumIndividualPlayerLatencyMilliseconds(123)
                 .policyDurationSeconds(123)
                 .build()))
         .priorityConfiguration(PriorityConfigurationProperty.builder()
                 .locationOrder(List.of("locationOrder"))
                 .priorityOrder(List.of("priorityOrder"))
                 .build())
         .timeoutInSeconds(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnGameSessionQueueProps.Builder A builder for CfnGameSessionQueueProps
static class	CfnGameSessionQueueProps.Jsii$Proxy An implementation for CfnGameSessionQueueProps

Method Summary

Modifier and Type	Method and Description
static CfnGameSessionQueueProps.Builder	builder()
default String	getCustomEventData() Information to be added to all events that are related to this game session queue.
default Object	getDestinations() A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
default Object	getFilterConfiguration() A list of locations where a queue is allowed to place new game sessions.
String	getName() A descriptive label that is associated with game session queue.
default String	getNotificationTarget() An SNS topic ARN that is set up to receive game session placement notifications.
default Object	getPlayerLatencyPolicies() A set of policies that act as a sliding cap on player latency.
default Object	getPriorityConfiguration() Custom settings to use when prioritizing destinations and locations for game session placements.
default Number	getTimeoutInSeconds() The maximum time, in seconds, that a new game session placement request remains in the queue.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Stable)
 @NotNull
String getName()

A descriptive label that is associated with game session queue.

Queue names must be unique within each Region.

getCustomEventData

@Stability(value=Stable)
 @Nullable
default String getCustomEventData()

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

getDestinations

@Stability(value=Stable)
 @Nullable
default Object getDestinations()

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.

getFilterConfiguration

@Stability(value=Stable)
 @Nullable
default Object getFilterConfiguration()

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.

getNotificationTarget

@Stability(value=Stable)
 @Nullable
default String getNotificationTarget()

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

See Setting up notifications for game session placement .

getPlayerLatencyPolicies

@Stability(value=Stable)
 @Nullable
default Object getPlayerLatencyPolicies()

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.

getPriorityConfiguration

@Stability(value=Stable)
 @Nullable
default Object getPriorityConfiguration()

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.

getTimeoutInSeconds

@Stability(value=Stable)
 @Nullable
default Number getTimeoutInSeconds()

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.

builder

@Stability(value=Stable)
static CfnGameSessionQueueProps.Builder builder()

Returns:

a CfnGameSessionQueueProps.Builder of CfnGameSessionQueueProps