Interface IGameSessionQueue
(experimental) Represents a Gamelift GameSessionQueue for a Gamelift fleet destination.
Namespace: Amazon.CDK.AWS.GameLift.Alpha
Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll
Syntax (csharp)
public interface IGameSessionQueue : IResource, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Interface IGameSessionQueue Inherits IResource, IConstruct, IDependable, IEnvironmentAware
Remarks
Stability: Experimental
Synopsis
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. |
Properties
GameSessionQueueArn
(experimental) The ARN of the gameSessionQueue.
string GameSessionQueueArn { get; }
Property Value
Remarks
Stability: Experimental
Attribute: true
GameSessionQueueName
(experimental) The Name of the gameSessionQueue.
string GameSessionQueueName { get; }
Property Value
Remarks
Stability: Experimental
Attribute: true
Methods
Metric(string, IMetricOptions?)
(experimental) Return the given named metric for this fleet.
Metric Metric(string metricName, IMetricOptions? props = null)
Parameters
- metricName string
- props IMetricOptions
Returns
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.
Metric MetricAverageWaitTime(IMetricOptions? props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Stability: Experimental
MetricPlacementsCanceled(IMetricOptions?)
(experimental) Game session placement requests that were canceled before timing out since the last report.
Metric MetricPlacementsCanceled(IMetricOptions? props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Stability: Experimental
MetricPlacementsFailed(IMetricOptions?)
(experimental) Game session placement requests that failed for any reason since the last report.
Metric MetricPlacementsFailed(IMetricOptions? props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Stability: Experimental
MetricPlacementsStarted(IMetricOptions?)
(experimental) New game session placement requests that were added to the queue since the last report.
Metric MetricPlacementsStarted(IMetricOptions? props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Stability: Experimental
MetricPlacementsSucceeded(IMetricOptions?)
(experimental) Game session placement requests that resulted in a new game session since the last report.
Metric MetricPlacementsSucceeded(IMetricOptions? props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Stability: Experimental
MetricPlacementsTimedOut(IMetricOptions?)
(experimental) Game session placement requests that reached the queue's timeout limit without being fulfilled since the last report.
Metric MetricPlacementsTimedOut(IMetricOptions? props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Stability: Experimental