Package software.amazon.awscdk.services.gamelift.alpha

Class GameSessionQueueProps.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.alpha.GameSessionQueueProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GameSessionQueueProps>

Enclosing interface:

GameSessionQueueProps

@Stability(Experimental)
public static final class GameSessionQueueProps.Builder
extends Object
implements software.amazon.jsii.Builder<GameSessionQueueProps>

A builder for GameSessionQueueProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GameSessionQueueProps.Builder	allowedLocations(List<String> allowedLocations)	Sets the value of GameSessionQueueProps.getAllowedLocations()
GameSessionQueueProps	build()	Builds the configured instance.
GameSessionQueueProps.Builder	customEventData(String customEventData)	Sets the value of GameSessionQueueProps.getCustomEventData()
GameSessionQueueProps.Builder	destinations(List<? extends IGameSessionQueueDestination> destinations)	Sets the value of GameSessionQueueProps.getDestinations()
GameSessionQueueProps.Builder	gameSessionQueueName(String gameSessionQueueName)	Sets the value of GameSessionQueueProps.getGameSessionQueueName()
GameSessionQueueProps.Builder	notificationTarget(ITopic notificationTarget)	Sets the value of GameSessionQueueProps.getNotificationTarget()
GameSessionQueueProps.Builder	playerLatencyPolicies(List<? extends PlayerLatencyPolicy> playerLatencyPolicies)	Sets the value of GameSessionQueueProps.getPlayerLatencyPolicies()
GameSessionQueueProps.Builder	priorityConfiguration(PriorityConfiguration priorityConfiguration)	Sets the value of GameSessionQueueProps.getPriorityConfiguration()
GameSessionQueueProps.Builder	timeout(Duration timeout)	Sets the value of GameSessionQueueProps.getTimeout()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

destinations

@Stability(Experimental)
public GameSessionQueueProps.Builder destinations(List<? extends IGameSessionQueueDestination> destinations)

Sets the value of GameSessionQueueProps.getDestinations()

Parameters:

destinations - A list of fleets and/or fleet alias that can be used to fulfill game session placement requests in the queue. This parameter is required. Destinations are listed in order of placement preference.

Returns:

this

gameSessionQueueName

@Stability(Experimental)
public GameSessionQueueProps.Builder gameSessionQueueName(String gameSessionQueueName)

Sets the value of GameSessionQueueProps.getGameSessionQueueName()

Parameters:

gameSessionQueueName - Name of this gameSessionQueue. This parameter is required.

Returns:

this

allowedLocations

@Stability(Experimental)
public GameSessionQueueProps.Builder allowedLocations(List<String> allowedLocations)

Sets the value of GameSessionQueueProps.getAllowedLocations()

Parameters:

allowedLocations - 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.

For queues that have multi-location fleets, you can use a filter configuration allow placement with some, but not all of these locations.

Returns:

this

customEventData

@Stability(Experimental)
public GameSessionQueueProps.Builder customEventData(String customEventData)

Sets the value of GameSessionQueueProps.getCustomEventData()

Parameters:

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

Returns:

this

notificationTarget

@Stability(Experimental)
public GameSessionQueueProps.Builder notificationTarget(ITopic notificationTarget)

Sets the value of GameSessionQueueProps.getNotificationTarget()

Parameters:

notificationTarget - An SNS topic is set up to receive game session placement notifications.

Returns:

this

playerLatencyPolicies

@Stability(Experimental)
public GameSessionQueueProps.Builder playerLatencyPolicies(List<? extends PlayerLatencyPolicy> playerLatencyPolicies)

Sets the value of GameSessionQueueProps.getPlayerLatencyPolicies()

Parameters:

playerLatencyPolicies - 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.

Returns:

this

priorityConfiguration

@Stability(Experimental)
public GameSessionQueueProps.Builder priorityConfiguration(PriorityConfiguration priorityConfiguration)

Sets the value of GameSessionQueueProps.getPriorityConfiguration()

Parameters:

priorityConfiguration - 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.

Returns:

this

timeout

@Stability(Experimental)
public GameSessionQueueProps.Builder timeout(Duration timeout)

Sets the value of GameSessionQueueProps.getTimeout()

Parameters:

timeout - The maximum time, 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.

Returns:

this

build

@Stability(Experimental)
public GameSessionQueueProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<GameSessionQueueProps>

Returns:

a new instance of GameSessionQueueProps

Throws:

NullPointerException - if any required attribute was not provided