Class GameSessionQueueBase

(experimental) Base class for new and imported GameLift GameSessionQueue.

Inheritance

object

Resource

GameSessionQueueBase

GameSessionQueue

Implements

IGameSessionQueue

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.GameLift.Alpha

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

Syntax (csharp)

public abstract class GameSessionQueueBase : Resource, IGameSessionQueue, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public MustInherit Class GameSessionQueueBase Inherits Resource Implements IGameSessionQueue, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

Stability: Experimental

Synopsis

Constructors

GameSessionQueueBase(Construct, string, IResourceProps?)

(experimental) Base class for new and imported GameLift GameSessionQueue.

Properties

GameSessionQueueArn	(experimental) The ARN of the gameSessionQueue.
GameSessionQueueName	(experimental) The name of the gameSessionQueue.

Methods

Metric(string, IMetricOptions?)	(experimental) Return the given named metric for this fleet.
MetricAverageWaitTime(IMetricOptions?)	(experimental) Average amount of time that game session placement requests in the queue with status PENDING have been waiting to be fulfilled.
MetricPlacementsCanceled(IMetricOptions?)	(experimental) Game session placement requests that were canceled before timing out since the last report.
MetricPlacementsFailed(IMetricOptions?)	(experimental) Game session placement requests that failed for any reason since the last report.
MetricPlacementsStarted(IMetricOptions?)	(experimental) New game session placement requests that were added to the queue since the last report.
MetricPlacementsSucceeded(IMetricOptions?)	(experimental) Game session placement requests that resulted in a new game session since the last report.
MetricPlacementsTimedOut(IMetricOptions?)	(experimental) Game session placement requests that reached the queue's timeout limit without being fulfilled since the last report.

Constructors

GameSessionQueueBase(Construct, string, IResourceProps?)

(experimental) Base class for new and imported GameLift GameSessionQueue.

protected GameSessionQueueBase(Construct scope, string id, IResourceProps? props = null)

Parameters

scope Construct

id string

props IResourceProps

Remarks

Stability: Experimental

Properties

GameSessionQueueArn

(experimental) The ARN of the gameSessionQueue.

public abstract string GameSessionQueueArn { get; }

Property Value

string

Remarks

Stability: Experimental

GameSessionQueueName

(experimental) The name of the gameSessionQueue.

public abstract string GameSessionQueueName { get; }

Property Value

string

Remarks

Stability: Experimental

Methods

Metric(string, IMetricOptions?)

(experimental) Return the given named metric for this fleet.

public virtual Metric Metric(string metricName, IMetricOptions? props = null)

Parameters

metricName string

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricAverageWaitTime(IMetricOptions?)

(experimental) Average amount of time that game session placement requests in the queue with status PENDING have been waiting to be fulfilled.

public virtual Metric MetricAverageWaitTime(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricPlacementsCanceled(IMetricOptions?)

(experimental) Game session placement requests that were canceled before timing out since the last report.

public virtual Metric MetricPlacementsCanceled(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricPlacementsFailed(IMetricOptions?)

(experimental) Game session placement requests that failed for any reason since the last report.

public virtual Metric MetricPlacementsFailed(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricPlacementsStarted(IMetricOptions?)

(experimental) New game session placement requests that were added to the queue since the last report.

public virtual Metric MetricPlacementsStarted(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricPlacementsSucceeded(IMetricOptions?)

(experimental) Game session placement requests that resulted in a new game session since the last report.

public virtual Metric MetricPlacementsSucceeded(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricPlacementsTimedOut(IMetricOptions?)

(experimental) Game session placement requests that reached the queue's timeout limit without being fulfilled since the last report.

public virtual Metric MetricPlacementsTimedOut(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

Implements

IGameSessionQueue

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware