interface IGameSessionQueue 🔹

Language	Type name
.NET	Amazon.CDK.AWS.GameLift.Alpha.IGameSessionQueue
Go	github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#IGameSessionQueue
Java	software.amazon.awscdk.services.gamelift.alpha.IGameSessionQueue
Python	aws_cdk.aws_gamelift_alpha.IGameSessionQueue
TypeScript (source)	@aws-cdk/aws-gamelift-alpha » IGameSessionQueue

Implemented by GameSessionQueue

Obtainable from GameSessionQueue.fromGameSessionQueueArn(), GameSessionQueue.fromGameSessionQueueAttributes(), GameSessionQueue.fromGameSessionQueueName()

Represents a Gamelift GameSessionQueue for a Gamelift fleet destination.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
gameSessionQueueArn🔹	string	The ARN of the gameSessionQueue.
gameSessionQueueName🔹	string	The Name of the gameSessionQueue.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

gameSessionQueueArn🔹

Type: string

The ARN of the gameSessionQueue.

---

gameSessionQueueName🔹

Type: string

The Name of the gameSessionQueue.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
metric(metricName, props?)🔹	Return the given named metric for this fleet.
metricAverageWaitTime(props?)🔹	Average amount of time that game session placement requests in the queue with status PENDING have been waiting to be fulfilled.
metricPlacementsCanceled(props?)🔹	Game session placement requests that were canceled before timing out since the last report.
metricPlacementsFailed(props?)🔹	Game session placement requests that failed for any reason since the last report.
metricPlacementsStarted(props?)🔹	New game session placement requests that were added to the queue since the last report.
metricPlacementsSucceeded(props?)🔹	Game session placement requests that resulted in a new game session since the last report.
metricPlacementsTimedOut(props?)🔹	Game session placement requests that reached the queue's timeout limit without being fulfilled since the last report.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

metric(metricName, props?)🔹

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Return the given named metric for this fleet.

---

metricAverageWaitTime(props?)🔹

public metricAverageWaitTime(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

---

metricPlacementsCanceled(props?)🔹

public metricPlacementsCanceled(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

---

metricPlacementsFailed(props?)🔹

public metricPlacementsFailed(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

---

metricPlacementsStarted(props?)🔹

public metricPlacementsStarted(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

---

metricPlacementsSucceeded(props?)🔹

public metricPlacementsSucceeded(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

---

metricPlacementsTimedOut(props?)🔹

public metricPlacementsTimedOut(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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