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

Experimental

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

GameSessionQueueBase L2 construct

Base class for new and imported GameLift GameSessionQueue.

Construct›Resource›GameSessionQueueBase

implements

• IGameSessionQueue,
• IResource,
• IEnvironmentAware,
• IConstruct,
• 1 more

  • IDependable

superclass of

• GameSessionQueue

Stability

Experimental

Source

lib/game-session-queue.ts

Initializer

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

GameSessionQueueBase(scope: Construct, id: str, props: typing.Optional[ResourceProps] = None)

new GameSessionQueueBase(Construct scope, String id, ResourceProps props)

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

NewGameSessionQueueBase(Scope Construct, Id *string, Props ResourceProps)

Construct Props

account?optionalstringaccount?optionalstraccount?optionalStringAccount?optionalstringAccount?optional*string#

The AWS account ID this resource belongs to.

Default: the resource is in the same account as the stack it belongs to

environmentFromArn?optionalstringenvironment_from_arn?optionalstrenvironmentFromArn?optionalStringEnvironmentFromArn?optionalstringEnvironmentFromArn?optional*string#

ARN to deduce region and account from.

Default: take environment from account, region parameters, or use Stack environment.

The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.

Cannot be supplied together with either account or region.

physicalName?optionalstringphysical_name?optionalstrphysicalName?optionalStringPhysicalName?optionalstringPhysicalName?optional*string#

The value passed in by users to the physical name prop of the resource.

Default: The physical name will be allocated by CloudFormation at deployment time

notes

• undefined implies that a physical name will be allocated by CloudFormation during deployment.
• a concrete value implies a specific physical name
• PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.

region?optionalstringregion?optionalstrregion?optionalStringRegion?optionalstringRegion?optional*string#

The AWS region this resource belongs to.

Default: the resource is in the same region as the stack it belongs to

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

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

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).

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

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.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

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. Use multiple with() calls if subsequent mixins should apply to added constructs.