Class GameSessionQueue

(experimental) The GameSessionQueue resource creates a placement queue that processes requests for new game sessions.

Inheritance

object

Resource

GameSessionQueueBase

GameSessionQueue

Implements

IGameSessionQueue

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

GameSessionQueueBase.Metric(string, IMetricOptions)

GameSessionQueueBase.MetricAverageWaitTime(IMetricOptions)

GameSessionQueueBase.MetricPlacementsCanceled(IMetricOptions)

GameSessionQueueBase.MetricPlacementsFailed(IMetricOptions)

GameSessionQueueBase.MetricPlacementsStarted(IMetricOptions)

GameSessionQueueBase.MetricPlacementsSucceeded(IMetricOptions)

GameSessionQueueBase.MetricPlacementsTimedOut(IMetricOptions)

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.With(params IMixin[])

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.GameLift.Alpha

Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll

Syntax (csharp)

public class GameSessionQueue : GameSessionQueueBase, IGameSessionQueue, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class GameSessionQueue Inherits GameSessionQueueBase Implements IGameSessionQueue, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server, then prompts the game server to start a new game session. Queues can have destinations (GameLift fleets or gameSessionQueuees), which determine where the queue can place new game sessions. A queue can have destinations with varied fleet type (Spot and On-Demand), instance type, and AWS Region.

Stability: Experimental

Resource: AWS::GameLift::GameSessionQueue

ExampleMetadata: infused

Examples

BuildFleet fleet;
             Alias alias;


             var queue = new GameSessionQueue(this, "GameSessionQueue", new GameSessionQueueProps {
                 GameSessionQueueName = "my-queue-name",
                 Destinations = new [] { fleet }
             });
             queue.AddDestination(alias);

Synopsis

Constructors

GameSessionQueue(Construct, string, IGameSessionQueueProps)

(experimental) The GameSessionQueue resource creates a placement queue that processes requests for new game sessions.

Properties

GameSessionQueueArn	(experimental) The ARN of the gameSessionQueue.
GameSessionQueueName	(experimental) The name of the gameSessionQueue.
PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.

Methods

AddDestination(IGameSessionQueueDestination)	(experimental) Adds a destination to fulfill requests for new game sessions.
FromGameSessionQueueArn(Construct, string, string)	(experimental) Import an existing gameSessionQueue from its ARN.
FromGameSessionQueueAttributes(Construct, string, IGameSessionQueueAttributes)	(experimental) Import an existing gameSessionQueue from its attributes.
FromGameSessionQueueName(Construct, string, string)	(experimental) Import an existing gameSessionQueue from its name.
ParseFilterConfiguration(IGameSessionQueueProps)	(experimental) The GameSessionQueue resource creates a placement queue that processes requests for new game sessions.
ParsePlayerLatencyPolicies(IGameSessionQueueProps)	(experimental) The GameSessionQueue resource creates a placement queue that processes requests for new game sessions.
ParsePriorityConfiguration(IGameSessionQueueProps)	(experimental) The GameSessionQueue resource creates a placement queue that processes requests for new game sessions.

Constructors

GameSessionQueue(Construct, string, IGameSessionQueueProps)

(experimental) The GameSessionQueue resource creates a placement queue that processes requests for new game sessions.

public GameSessionQueue(Construct scope, string id, IGameSessionQueueProps props)

Parameters

scope Construct
id string
props IGameSessionQueueProps

Remarks

Stability: Experimental

Properties

GameSessionQueueArn

(experimental) The ARN of the gameSessionQueue.

public override string GameSessionQueueArn { get; }

Property Value

string

Overrides

GameSessionQueueBase.GameSessionQueueArn

Remarks

Stability: Experimental

GameSessionQueueName

(experimental) The name of the gameSessionQueue.

public override string GameSessionQueueName { get; }

Property Value

string

Overrides

GameSessionQueueBase.GameSessionQueueName

Remarks

Stability: Experimental

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Stability: Experimental

Methods

AddDestination(IGameSessionQueueDestination)

(experimental) Adds a destination to fulfill requests for new game sessions.

public virtual void AddDestination(IGameSessionQueueDestination destination)

Parameters

destination IGameSessionQueueDestination: A destination to add.

Remarks

Stability: Experimental

FromGameSessionQueueArn(Construct, string, string)

(experimental) Import an existing gameSessionQueue from its ARN.

public static IGameSessionQueue FromGameSessionQueueArn(Construct scope, string id, string gameSessionQueueArn)

Parameters

scope Construct
id string
gameSessionQueueArn string

Returns

IGameSessionQueue

Remarks

Stability: Experimental

FromGameSessionQueueAttributes(Construct, string, IGameSessionQueueAttributes)

(experimental) Import an existing gameSessionQueue from its attributes.

public static IGameSessionQueue FromGameSessionQueueAttributes(Construct scope, string id, IGameSessionQueueAttributes attrs)

Parameters

scope Construct
id string
attrs IGameSessionQueueAttributes

Returns

IGameSessionQueue

Remarks

Stability: Experimental

FromGameSessionQueueName(Construct, string, string)

(experimental) Import an existing gameSessionQueue from its name.

public static IGameSessionQueue FromGameSessionQueueName(Construct scope, string id, string gameSessionQueueName)

Parameters

scope Construct
id string
gameSessionQueueName string

Returns

IGameSessionQueue

Remarks

Stability: Experimental

ParseFilterConfiguration(IGameSessionQueueProps)

(experimental) The GameSessionQueue resource creates a placement queue that processes requests for new game sessions.

protected virtual CfnGameSessionQueue.IFilterConfigurationProperty? ParseFilterConfiguration(IGameSessionQueueProps props)

Parameters

props IGameSessionQueueProps

Returns

CfnGameSessionQueue.IFilterConfigurationProperty

Remarks

Stability: Experimental

ParsePlayerLatencyPolicies(IGameSessionQueueProps)

(experimental) The GameSessionQueue resource creates a placement queue that processes requests for new game sessions.

protected virtual CfnGameSessionQueue.IPlayerLatencyPolicyProperty[]? ParsePlayerLatencyPolicies(IGameSessionQueueProps props)

Parameters

props IGameSessionQueueProps

Returns

IPlayerLatencyPolicyProperty[]

Remarks

Stability: Experimental

ParsePriorityConfiguration(IGameSessionQueueProps)

(experimental) The GameSessionQueue resource creates a placement queue that processes requests for new game sessions.

protected virtual CfnGameSessionQueue.IPriorityConfigurationProperty? ParsePriorityConfiguration(IGameSessionQueueProps props)

Parameters

props IGameSessionQueueProps

Returns

CfnGameSessionQueue.IPriorityConfigurationProperty

Remarks

Stability: Experimental

Implements

IGameSessionQueue

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware