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

Class GameSessionQueueBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.gamelift.alpha.GameSessionQueueBase

All Implemented Interfaces:

IResource, IGameSessionQueue, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

GameSessionQueue

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:15.686Z")
@Stability(Experimental)
public abstract class GameSessionQueueBase
extends Resource
implements IGameSessionQueue

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

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.alpha.IGameSessionQueue

IGameSessionQueue.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GameSessionQueueBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GameSessionQueueBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	GameSessionQueueBase(software.constructs.Construct scope, String id)
protected	GameSessionQueueBase(software.constructs.Construct scope, String id, ResourceProps props)

Method Summary

Modifier and Type	Method	Description
abstract String	getGameSessionQueueArn()	(experimental) The ARN of the gameSessionQueue.
abstract String	getGameSessionQueueName()	(experimental) The name of the gameSessionQueue.
Metric	metric(String metricName)	(experimental) Return the given named metric for this fleet.
Metric	metric(String metricName, MetricOptions props)	(experimental) Return the given named metric for this fleet.
Metric	metricAverageWaitTime()	(experimental) Average amount of time that game session placement requests in the queue with status PENDING have been waiting to be fulfilled.
Metric	metricAverageWaitTime(MetricOptions props)	(experimental) Average amount of time that game session placement requests in the queue with status PENDING have been waiting to be fulfilled.
Metric	metricPlacementsCanceled()	(experimental) Game session placement requests that were canceled before timing out since the last report.
Metric	metricPlacementsCanceled(MetricOptions props)	(experimental) Game session placement requests that were canceled before timing out since the last report.
Metric	metricPlacementsFailed()	(experimental) Game session placement requests that failed for any reason since the last report.
Metric	metricPlacementsFailed(MetricOptions props)	(experimental) Game session placement requests that failed for any reason since the last report.
Metric	metricPlacementsStarted()	(experimental) New game session placement requests that were added to the queue since the last report.
Metric	metricPlacementsStarted(MetricOptions props)	(experimental) New game session placement requests that were added to the queue since the last report.
Metric	metricPlacementsSucceeded()	(experimental) Game session placement requests that resulted in a new game session since the last report.
Metric	metricPlacementsSucceeded(MetricOptions props)	(experimental) Game session placement requests that resulted in a new game session since the last report.
Metric	metricPlacementsTimedOut()	(experimental) Game session placement requests that reached the queue's timeout limit without being fulfilled since the last report.
Metric	metricPlacementsTimedOut(MetricOptions props)	(experimental) Game session placement requests that reached the queue's timeout limit without being fulfilled since the last report.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

GameSessionQueueBase

protected GameSessionQueueBase(software.amazon.jsii.JsiiObjectRef objRef)

GameSessionQueueBase

protected GameSessionQueueBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

GameSessionQueueBase

@Stability(Stable)
protected GameSessionQueueBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

GameSessionQueueBase

@Stability(Stable)
protected GameSessionQueueBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

metric

@Stability(Experimental)
@NotNull
public Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

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

Specified by:

metric in interface IGameSessionQueue

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(Experimental)
@NotNull
public Metric metric(@NotNull
 String metricName)

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

Specified by:

metric in interface IGameSessionQueue

Parameters:

metricName - This parameter is required.

metricAverageWaitTime

@Stability(Experimental)
@NotNull
public Metric metricAverageWaitTime(@Nullable
 MetricOptions props)

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

Specified by:

metricAverageWaitTime in interface IGameSessionQueue

Parameters:

props -

metricAverageWaitTime

@Stability(Experimental)
@NotNull
public Metric metricAverageWaitTime()

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

Specified by:

metricAverageWaitTime in interface IGameSessionQueue

metricPlacementsCanceled

@Stability(Experimental)
@NotNull
public Metric metricPlacementsCanceled(@Nullable
 MetricOptions props)

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

Specified by:

metricPlacementsCanceled in interface IGameSessionQueue

Parameters:

props -

metricPlacementsCanceled

@Stability(Experimental)
@NotNull
public Metric metricPlacementsCanceled()

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

Specified by:

metricPlacementsCanceled in interface IGameSessionQueue

metricPlacementsFailed

@Stability(Experimental)
@NotNull
public Metric metricPlacementsFailed(@Nullable
 MetricOptions props)

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

Specified by:

metricPlacementsFailed in interface IGameSessionQueue

Parameters:

props -

metricPlacementsFailed

@Stability(Experimental)
@NotNull
public Metric metricPlacementsFailed()

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

Specified by:

metricPlacementsFailed in interface IGameSessionQueue

metricPlacementsStarted

@Stability(Experimental)
@NotNull
public Metric metricPlacementsStarted(@Nullable
 MetricOptions props)

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

Specified by:

metricPlacementsStarted in interface IGameSessionQueue

Parameters:

props -

metricPlacementsStarted

@Stability(Experimental)
@NotNull
public Metric metricPlacementsStarted()

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

Specified by:

metricPlacementsStarted in interface IGameSessionQueue

metricPlacementsSucceeded

@Stability(Experimental)
@NotNull
public Metric metricPlacementsSucceeded(@Nullable
 MetricOptions props)

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

Specified by:

metricPlacementsSucceeded in interface IGameSessionQueue

Parameters:

props -

metricPlacementsSucceeded

@Stability(Experimental)
@NotNull
public Metric metricPlacementsSucceeded()

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

Specified by:

metricPlacementsSucceeded in interface IGameSessionQueue

metricPlacementsTimedOut

@Stability(Experimental)
@NotNull
public Metric metricPlacementsTimedOut(@Nullable
 MetricOptions props)

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

Specified by:

metricPlacementsTimedOut in interface IGameSessionQueue

Parameters:

props -

metricPlacementsTimedOut

@Stability(Experimental)
@NotNull
public Metric metricPlacementsTimedOut()

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

Specified by:

metricPlacementsTimedOut in interface IGameSessionQueue

getGameSessionQueueArn

@Stability(Experimental)
@NotNull
public abstract String getGameSessionQueueArn()

(experimental) The ARN of the gameSessionQueue.

Specified by:

getGameSessionQueueArn in interface IGameSessionQueue

getGameSessionQueueName

@Stability(Experimental)
@NotNull
public abstract String getGameSessionQueueName()

(experimental) The name of the gameSessionQueue.

Specified by:

getGameSessionQueueName in interface IGameSessionQueue