Package software.amazon.awscdk.services.gamelift

Class CfnGameSessionQueue.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.CfnGameSessionQueue.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGameSessionQueue>

Enclosing class:

CfnGameSessionQueue

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

A fluent builder for CfnGameSessionQueue.

Method Summary

Modifier and Type	Method	Description
CfnGameSessionQueue	build()
static CfnGameSessionQueue.Builder	create(software.constructs.Construct scope, String id)
CfnGameSessionQueue.Builder	customEventData(String customEventData)	Information to be added to all events that are related to this game session queue.
CfnGameSessionQueue.Builder	destinations(List<? extends Object> destinations)	A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
CfnGameSessionQueue.Builder	destinations(IResolvable destinations)	A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
CfnGameSessionQueue.Builder	filterConfiguration(IResolvable filterConfiguration)	A list of locations where a queue is allowed to place new game sessions.
CfnGameSessionQueue.Builder	filterConfiguration(CfnGameSessionQueue.FilterConfigurationProperty filterConfiguration)	A list of locations where a queue is allowed to place new game sessions.
CfnGameSessionQueue.Builder	name(String name)	A descriptive label that is associated with game session queue.
CfnGameSessionQueue.Builder	notificationTarget(String notificationTarget)	An SNS topic ARN that is set up to receive game session placement notifications.
CfnGameSessionQueue.Builder	playerLatencyPolicies(List<? extends Object> playerLatencyPolicies)	A set of policies that act as a sliding cap on player latency.
CfnGameSessionQueue.Builder	playerLatencyPolicies(IResolvable playerLatencyPolicies)	A set of policies that act as a sliding cap on player latency.
CfnGameSessionQueue.Builder	priorityConfiguration(IResolvable priorityConfiguration)	Custom settings to use when prioritizing destinations and locations for game session placements.
CfnGameSessionQueue.Builder	priorityConfiguration(CfnGameSessionQueue.PriorityConfigurationProperty priorityConfiguration)	Custom settings to use when prioritizing destinations and locations for game session placements.
CfnGameSessionQueue.Builder	tags(List<? extends CfnTag> tags)	A list of labels to assign to the new game session queue resource.
CfnGameSessionQueue.Builder	timeoutInSeconds(Number timeoutInSeconds)	The maximum time, in seconds, that a new game session placement request remains in the queue.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnGameSessionQueue.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnGameSessionQueue.Builder.

name

@Stability(Stable)
public CfnGameSessionQueue.Builder name(String name)

A descriptive label that is associated with game session queue.

Queue names must be unique within each Region.

Parameters:

name - A descriptive label that is associated with game session queue. This parameter is required.

Returns:

this

See Also:

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

customEventData

@Stability(Stable)
public CfnGameSessionQueue.Builder customEventData(String customEventData)

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

Parameters:

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

Returns:

this

See Also:

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

destinations

@Stability(Stable)
public CfnGameSessionQueue.Builder destinations(IResolvable 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.

Parameters:

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

Returns:

this

See Also:

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

destinations

@Stability(Stable)
public CfnGameSessionQueue.Builder destinations(List<? extends Object> 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.

Parameters:

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

Returns:

this

See Also:

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

filterConfiguration

@Stability(Stable)
public CfnGameSessionQueue.Builder filterConfiguration(IResolvable filterConfiguration)

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.

Parameters:

filterConfiguration - A list of locations where a queue is allowed to place new game sessions. This parameter is required.

Returns:

this

See Also:

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

filterConfiguration

@Stability(Stable)
public CfnGameSessionQueue.Builder filterConfiguration(CfnGameSessionQueue.FilterConfigurationProperty filterConfiguration)

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.

Parameters:

filterConfiguration - A list of locations where a queue is allowed to place new game sessions. This parameter is required.

Returns:

this

See Also:

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

notificationTarget

@Stability(Stable)
public CfnGameSessionQueue.Builder notificationTarget(String notificationTarget)

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

See Setting up notifications for game session placement .

Parameters:

notificationTarget - An SNS topic ARN that is set up to receive game session placement notifications. This parameter is required.

Returns:

this

See Also:

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

playerLatencyPolicies

@Stability(Stable)
public CfnGameSessionQueue.Builder playerLatencyPolicies(IResolvable 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.

Parameters:

playerLatencyPolicies - A set of policies that act as a sliding cap on player latency. This parameter is required.

Returns:

this

See Also:

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

playerLatencyPolicies

@Stability(Stable)
public CfnGameSessionQueue.Builder playerLatencyPolicies(List<? extends Object> 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.

Parameters:

playerLatencyPolicies - A set of policies that act as a sliding cap on player latency. This parameter is required.

Returns:

this

See Also:

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

priorityConfiguration

@Stability(Stable)
public CfnGameSessionQueue.Builder priorityConfiguration(IResolvable 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.

Parameters:

priorityConfiguration - Custom settings to use when prioritizing destinations and locations for game session placements. This parameter is required.

Returns:

this

See Also:

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

priorityConfiguration

@Stability(Stable)
public CfnGameSessionQueue.Builder priorityConfiguration(CfnGameSessionQueue.PriorityConfigurationProperty 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.

Parameters:

priorityConfiguration - Custom settings to use when prioritizing destinations and locations for game session placements. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnGameSessionQueue.Builder tags(List<? extends CfnTag> 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.

Parameters:

tags - A list of labels to assign to the new game session queue resource. This parameter is required.

Returns:

this

See Also:

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

timeoutInSeconds

@Stability(Stable)
public CfnGameSessionQueue.Builder timeoutInSeconds(Number timeoutInSeconds)

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. By default, this property is set to 600 .

Parameters:

timeoutInSeconds - The maximum time, in seconds, that a new game session placement request remains in the queue. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnGameSessionQueue build()

Specified by:

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

Returns:

a newly built instance of CfnGameSessionQueue.