@aws-cdk_aws-gamelift-alpha.GameSessionQueueBase

class GameSessionQueueBase ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.GameLift.Alpha.GameSessionQueueBase
Gogithub.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#GameSessionQueueBase
Javasoftware.amazon.awscdk.services.gamelift.alpha.GameSessionQueueBase
Pythonaws_cdk.aws_gamelift_alpha.GameSessionQueueBase
TypeScript (source)@aws-cdk/aws-gamelift-alpha ยป GameSessionQueueBase

Implements IConstruct, IDependable, IResource, IGameSessionQueue

Extends Resource

Implemented by GameSessionQueue

Base class for new and imported GameLift GameSessionQueue.

Initializer

new GameSessionQueueBase(scope: Construct, id: string, props?: ResourceProps)

Parameters

  • scope Construct
  • id string
  • props ResourceProps

Properties

NameTypeDescription
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
gameSessionQueueArn๐Ÿ”นstringThe ARN of the gameSessionQueue.
gameSessionQueueName๐Ÿ”นstringThe name of the gameSessionQueue.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe 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

NameDescription
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.
toString()๐Ÿ”นReturns a string representation of this construct.

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.


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.