class GameSessionQueueBase
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.GameLift.Alpha.GameSessionQueueBase |
![]() | github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#GameSessionQueueBase |
![]() | software.amazon.awscdk.services.gamelift.alpha.GameSessionQueueBase |
![]() | aws_cdk.aws_gamelift_alpha.GameSessionQueueBase |
![]() | @aws-cdk/aws-gamelift-alpha ยป GameSessionQueueBase |
Implements
IConstruct
, IDependable
, IResource
, IGame
Extends
Resource
Implemented by
Game
Base class for new and imported GameLift GameSessionQueue.
Initializer
new GameSessionQueueBase(scope: Construct, id: string, props?: ResourceProps)
Parameters
- scope
Construct
- id
string
- props
Resource
Props
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
game | string | The ARN of the gameSessionQueue. |
game | string | The name of the gameSessionQueue. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
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 |
---|---|
apply | Apply the given removal policy to this resource. |
metric(metricName, props?) | Return the given named metric for this fleet. |
metric | Average amount of time that game session placement requests in the queue with status PENDING have been waiting to be fulfilled. |
metric | Game session placement requests that were canceled before timing out since the last report. |
metric | Game session placement requests that failed for any reason since the last report. |
metric | New game session placement requests that were added to the queue since the last report. |
metric | Game session placement requests that resulted in a new game session since the last report. |
metric | Game session placement requests that reached the queue's timeout limit without being fulfilled since the last report. |
to | Returns a string representation of this construct. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
Metric
Options
Returns
Return the given named metric for this fleet.
metricAverageWaitTime(props?)
public metricAverageWaitTime(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
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
Metric
Options
Returns
Game session placement requests that were canceled before timing out since the last report.
metricPlacementsFailed(props?)
public metricPlacementsFailed(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Game session placement requests that failed for any reason since the last report.
metricPlacementsStarted(props?)
public metricPlacementsStarted(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
New game session placement requests that were added to the queue since the last report.
metricPlacementsSucceeded(props?)
public metricPlacementsSucceeded(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Game session placement requests that resulted in a new game session since the last report.
metricPlacementsTimedOut(props?)
public metricPlacementsTimedOut(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
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.