Package software.amazon.awscdk.cfnpropertymixins.services.gamelift

Class CfnGameSessionQueuePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.gamelift.CfnGameSessionQueuePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGameSessionQueuePropsMixin>

Enclosing class:

CfnGameSessionQueuePropsMixin

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

A fluent builder for CfnGameSessionQueuePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnGameSessionQueuePropsMixin	build()
static CfnGameSessionQueuePropsMixin.Builder	create()
static CfnGameSessionQueuePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnGameSessionQueuePropsMixin.Builder	customEventData(String customEventData)	Information to be added to all events that are related to this game session queue.
CfnGameSessionQueuePropsMixin.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.
CfnGameSessionQueuePropsMixin.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.
CfnGameSessionQueuePropsMixin.Builder	filterConfiguration(CfnGameSessionQueuePropsMixin.FilterConfigurationProperty filterConfiguration)	A list of locations where a queue is allowed to place new game sessions.
CfnGameSessionQueuePropsMixin.Builder	filterConfiguration(IResolvable filterConfiguration)	A list of locations where a queue is allowed to place new game sessions.
CfnGameSessionQueuePropsMixin.Builder	name(String name)	A descriptive label that is associated with game session queue.
CfnGameSessionQueuePropsMixin.Builder	notificationTarget(String notificationTarget)	An SNS topic ARN that is set up to receive game session placement notifications.
CfnGameSessionQueuePropsMixin.Builder	playerLatencyPolicies(List<? extends Object> playerLatencyPolicies)	A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests.
CfnGameSessionQueuePropsMixin.Builder	playerLatencyPolicies(IResolvable playerLatencyPolicies)	A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests.
CfnGameSessionQueuePropsMixin.Builder	priorityConfiguration(CfnGameSessionQueuePropsMixin.PriorityConfigurationProperty priorityConfiguration)	Custom settings to use when prioritizing destinations and locations for game session placements.
CfnGameSessionQueuePropsMixin.Builder	priorityConfiguration(IResolvable priorityConfiguration)	Custom settings to use when prioritizing destinations and locations for game session placements.
CfnGameSessionQueuePropsMixin.Builder	tags(List<? extends CfnTag> tags)	A list of labels to assign to the new game session queue resource.
CfnGameSessionQueuePropsMixin.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 CfnGameSessionQueuePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnGameSessionQueuePropsMixin.Builder.

create

@Stability(Stable)
public static CfnGameSessionQueuePropsMixin.Builder create()

Returns:

a new instance of CfnGameSessionQueuePropsMixin.Builder.

customEventData

@Stability(Stable)
public CfnGameSessionQueuePropsMixin.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 CfnGameSessionQueuePropsMixin.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 CfnGameSessionQueuePropsMixin.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 CfnGameSessionQueuePropsMixin.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 CfnGameSessionQueuePropsMixin.Builder filterConfiguration(CfnGameSessionQueuePropsMixin.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

name

@Stability(Stable)
public CfnGameSessionQueuePropsMixin.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

notificationTarget

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

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.

Parameters:

playerLatencyPolicies - A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. 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 CfnGameSessionQueuePropsMixin.Builder playerLatencyPolicies(List<? extends Object> playerLatencyPolicies)

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.

Parameters:

playerLatencyPolicies - A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. 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 CfnGameSessionQueuePropsMixin.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 CfnGameSessionQueuePropsMixin.Builder priorityConfiguration(CfnGameSessionQueuePropsMixin.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 CfnGameSessionQueuePropsMixin.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 CfnGameSessionQueuePropsMixin.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. If you don't specify a request timeout, the queue uses a default value.

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 CfnGameSessionQueuePropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnGameSessionQueuePropsMixin.