@aws-cdk/aws-gamelift-alpha.IGameSessionQueue

Experimental

@aws-cdk/aws-gamelift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

IGameSessionQueue Interface

Represents a Gamelift GameSessionQueue for a Gamelift fleet destination.

IGameSessionQueue

extends

• IResource

implemented by

• GameSessionQueue,
• GameSessionQueueBase

Stability

Experimental

Source

lib/game-session-queue.ts

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

gameSessionQueueArnstringgame_session_queue_arnstrgameSessionQueueArnStringGameSessionQueueArnstringGameSessionQueueArn*stringrequired#

The ARN of the gameSessionQueue.

gameSessionQueueNamestringgame_session_queue_namestrgameSessionQueueNameStringGameSessionQueueNamestringGameSessionQueueName*stringrequired#

The Name of the gameSessionQueue.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

Methods

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metric#

Return the given named metric for this fleet.

metricAverageWaitTime(props?: MetricOptions): Metricdef metric_average_wait_time(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricAverageWaitTime(MetricOptions props)public Metric MetricAverageWaitTime(MetricOptions? props = null)func MetricAverageWaitTime(Props MetricOptions) Metric#

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

metricPlacementsCanceled(props?: MetricOptions): Metricdef metric_placements_canceled(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricPlacementsCanceled(MetricOptions props)public Metric MetricPlacementsCanceled(MetricOptions? props = null)func MetricPlacementsCanceled(Props MetricOptions) Metric#

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

metricPlacementsFailed(props?: MetricOptions): Metricdef metric_placements_failed(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricPlacementsFailed(MetricOptions props)public Metric MetricPlacementsFailed(MetricOptions? props = null)func MetricPlacementsFailed(Props MetricOptions) Metric#

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

metricPlacementsStarted(props?: MetricOptions): Metricdef metric_placements_started(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricPlacementsStarted(MetricOptions props)public Metric MetricPlacementsStarted(MetricOptions? props = null)func MetricPlacementsStarted(Props MetricOptions) Metric#

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

metricPlacementsSucceeded(props?: MetricOptions): Metricdef metric_placements_succeeded(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricPlacementsSucceeded(MetricOptions props)public Metric MetricPlacementsSucceeded(MetricOptions? props = null)func MetricPlacementsSucceeded(Props MetricOptions) Metric#

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

metricPlacementsTimedOut(props?: MetricOptions): Metricdef metric_placements_timed_out(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricPlacementsTimedOut(MetricOptions props)public Metric MetricPlacementsTimedOut(MetricOptions? props = null)func MetricPlacementsTimedOut(Props MetricOptions) Metric#

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

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining