Package software.amazon.awscdk.services.gamelift.alpha

Class IBuildFleet.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.gamelift.alpha.IBuildFleet.Jsii$Proxy

All Implemented Interfaces:

IEnvironmentAware, IEnvironmentAware.Jsii$Default, IResource, IResource.Jsii$Default, IBuildFleet, IBuildFleet.Jsii$Default, IFleet, IFleet.Jsii$Default, IGameSessionQueueDestination, IGameSessionQueueDestination.Jsii$Default, IGrantable, IGrantable.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default

Enclosing interface:

IBuildFleet

@Internal
public static final class IBuildFleet.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IBuildFleet.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.alpha.IBuildFleet

IBuildFleet.Jsii$Default, IBuildFleet.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.alpha.IFleet

IFleet.Jsii$Default, IFleet.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.alpha.IGameSessionQueueDestination

IGameSessionQueueDestination.Jsii$Default, IGameSessionQueueDestination.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
final void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
final ResourceEnvironment	getEnv()	The environment this resource belongs to.
final String	getFleetArn()	(experimental) The ARN of the fleet.
final String	getFleetId()	(experimental) The Identifier of the fleet.
final IPrincipal	getGrantPrincipal()	The principal to grant permissions to.
final software.constructs.Node	getNode()	The tree node.
final String	getResourceArnForDestination()	(experimental) The ARN(s) to put into the destination field for a game session queue.
final Stack	getStack()	The stack in which this resource is defined.
final Grant	grant(IGrantable grantee, String... actions)	(experimental) Grant the grantee identity permissions to perform actions.
final Metric	metric(String metricName)	(experimental) Return the given named metric for this fleet.
final Metric	metric(String metricName, MetricOptions props)	(experimental) Return the given named metric for this fleet.
final Metric	metricActiveInstances()	(experimental) Instances with ACTIVE status, which means they are running active server processes.
final Metric	metricActiveInstances(MetricOptions props)	(experimental) Instances with ACTIVE status, which means they are running active server processes.
final Metric	metricDesiredInstances()	(experimental) Target number of active instances that GameLift is working to maintain in the fleet.
final Metric	metricDesiredInstances(MetricOptions props)	(experimental) Target number of active instances that GameLift is working to maintain in the fleet.
final Metric	metricIdleInstances()	(experimental) Active instances that are currently hosting zero (0) game sessions.
final Metric	metricIdleInstances(MetricOptions props)	(experimental) Active instances that are currently hosting zero (0) game sessions.
final Metric	metricInstanceInterruptions()	(experimental) Number of spot instances that have been interrupted.
final Metric	metricInstanceInterruptions(MetricOptions props)	(experimental) Number of spot instances that have been interrupted.
final Metric	metricMaxInstances()	(experimental) Maximum number of instances that are allowed for the fleet.
final Metric	metricMaxInstances(MetricOptions props)	(experimental) Maximum number of instances that are allowed for the fleet.
final Metric	metricMinInstances()	(experimental) Minimum number of instances allowed for the fleet.
final Metric	metricMinInstances(MetricOptions props)	(experimental) Minimum number of instances allowed for the fleet.
final Metric	metricPercentIdleInstances()	(experimental) Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances).
final Metric	metricPercentIdleInstances(MetricOptions props)	(experimental) Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances).

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Details

getNode

@Stability(Stable)
@NotNull
public final software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface IBuildFleet.Jsii$Default

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IFleet.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
public final ResourceEnvironment getEnv()

The environment this resource belongs to.

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.

Specified by:

getEnv in interface IBuildFleet.Jsii$Default

Specified by:

getEnv in interface IEnvironmentAware

Specified by:

getEnv in interface IEnvironmentAware.Jsii$Default

Specified by:

getEnv in interface IFleet.Jsii$Default

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IBuildFleet.Jsii$Default

Specified by:

getStack in interface IFleet.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getGrantPrincipal

@Stability(Stable)
@NotNull
public final IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IBuildFleet.Jsii$Default

Specified by:

getGrantPrincipal in interface IFleet.Jsii$Default

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

getResourceArnForDestination

@Stability(Experimental)
@NotNull
public final String getResourceArnForDestination()

(experimental) The ARN(s) to put into the destination field for a game session queue.

This property is for cdk modules to consume only. You should not need to use this property. Instead, use dedicated identifier on each components.

Specified by:

getResourceArnForDestination in interface IBuildFleet.Jsii$Default

Specified by:

getResourceArnForDestination in interface IFleet.Jsii$Default

Specified by:

getResourceArnForDestination in interface IGameSessionQueueDestination

Specified by:

getResourceArnForDestination in interface IGameSessionQueueDestination.Jsii$Default

getFleetArn

@Stability(Experimental)
@NotNull
public final String getFleetArn()

(experimental) The ARN of the fleet.

Specified by:

getFleetArn in interface IBuildFleet.Jsii$Default

Specified by:

getFleetArn in interface IFleet

Specified by:

getFleetArn in interface IFleet.Jsii$Default

getFleetId

@Stability(Experimental)
@NotNull
public final String getFleetId()

(experimental) The Identifier of the fleet.

Specified by:

getFleetId in interface IBuildFleet.Jsii$Default

Specified by:

getFleetId in interface IFleet

Specified by:

getFleetId in interface IFleet.Jsii$Default

applyRemovalPolicy

@Stability(Stable)
public final void applyRemovalPolicy(@NotNull
 RemovalPolicy 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).

Specified by:

applyRemovalPolicy in interface IBuildFleet.Jsii$Default

Specified by:

applyRemovalPolicy in interface IFleet.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

grant

@Stability(Experimental)
@NotNull
public final Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 String... actions)

(experimental) Grant the grantee identity permissions to perform actions.

Specified by:

grant in interface IBuildFleet.Jsii$Default

Specified by:

grant in interface IFleet

Specified by:

grant in interface IFleet.Jsii$Default

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

metric

@Stability(Experimental)
@NotNull
public final Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

(experimental) Return the given named metric for this fleet.

Specified by:

metric in interface IBuildFleet.Jsii$Default

Specified by:

metric in interface IFleet

Specified by:

metric in interface IFleet.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(Experimental)
@NotNull
public final Metric metric(@NotNull
 String metricName)

(experimental) Return the given named metric for this fleet.

Specified by:

metric in interface IFleet

Parameters:

metricName - This parameter is required.

metricActiveInstances

@Stability(Experimental)
@NotNull
public final Metric metricActiveInstances(@Nullable
 MetricOptions props)

(experimental) Instances with ACTIVE status, which means they are running active server processes.

The count includes idle instances and those that are hosting one or more game sessions. This metric measures current total instance capacity.

This metric can be used with automatic scaling.

Specified by:

metricActiveInstances in interface IBuildFleet.Jsii$Default

Specified by:

metricActiveInstances in interface IFleet

Specified by:

metricActiveInstances in interface IFleet.Jsii$Default

Parameters:

props -

metricActiveInstances

@Stability(Experimental)
@NotNull
public final Metric metricActiveInstances()

(experimental) Instances with ACTIVE status, which means they are running active server processes.

The count includes idle instances and those that are hosting one or more game sessions. This metric measures current total instance capacity.

This metric can be used with automatic scaling.

Specified by:

metricActiveInstances in interface IFleet

metricDesiredInstances

@Stability(Experimental)
@NotNull
public final Metric metricDesiredInstances(@Nullable
 MetricOptions props)

(experimental) Target number of active instances that GameLift is working to maintain in the fleet.

With automatic scaling, this value is determined based on the scaling policies currently in force. Without automatic scaling, this value is set manually. This metric is not available when viewing data for fleet metric groups.

Specified by:

metricDesiredInstances in interface IBuildFleet.Jsii$Default

Specified by:

metricDesiredInstances in interface IFleet

Specified by:

metricDesiredInstances in interface IFleet.Jsii$Default

Parameters:

props -

metricDesiredInstances

@Stability(Experimental)
@NotNull
public final Metric metricDesiredInstances()

(experimental) Target number of active instances that GameLift is working to maintain in the fleet.

With automatic scaling, this value is determined based on the scaling policies currently in force. Without automatic scaling, this value is set manually. This metric is not available when viewing data for fleet metric groups.

Specified by:

metricDesiredInstances in interface IFleet

metricIdleInstances

@Stability(Experimental)
@NotNull
public final Metric metricIdleInstances(@Nullable
 MetricOptions props)

(experimental) Active instances that are currently hosting zero (0) game sessions.

This metric measures capacity that is available but unused. This metric can be used with automatic scaling.

Specified by:

metricIdleInstances in interface IBuildFleet.Jsii$Default

Specified by:

metricIdleInstances in interface IFleet

Specified by:

metricIdleInstances in interface IFleet.Jsii$Default

Parameters:

props -

metricIdleInstances

@Stability(Experimental)
@NotNull
public final Metric metricIdleInstances()

(experimental) Active instances that are currently hosting zero (0) game sessions.

This metric measures capacity that is available but unused. This metric can be used with automatic scaling.

Specified by:

metricIdleInstances in interface IFleet

metricInstanceInterruptions

@Stability(Experimental)
@NotNull
public final Metric metricInstanceInterruptions(@Nullable
 MetricOptions props)

(experimental) Number of spot instances that have been interrupted.

Specified by:

metricInstanceInterruptions in interface IBuildFleet.Jsii$Default

Specified by:

metricInstanceInterruptions in interface IFleet

Specified by:

metricInstanceInterruptions in interface IFleet.Jsii$Default

Parameters:

props -

metricInstanceInterruptions

@Stability(Experimental)
@NotNull
public final Metric metricInstanceInterruptions()

(experimental) Number of spot instances that have been interrupted.

Specified by:

metricInstanceInterruptions in interface IFleet

metricMaxInstances

@Stability(Experimental)
@NotNull
public final Metric metricMaxInstances(@Nullable
 MetricOptions props)

(experimental) Maximum number of instances that are allowed for the fleet.

A fleet's instance maximum determines the capacity ceiling during manual or automatic scaling up. This metric is not available when viewing data for fleet metric groups.

Specified by:

metricMaxInstances in interface IBuildFleet.Jsii$Default

Specified by:

metricMaxInstances in interface IFleet

Specified by:

metricMaxInstances in interface IFleet.Jsii$Default

Parameters:

props -

metricMaxInstances

@Stability(Experimental)
@NotNull
public final Metric metricMaxInstances()

(experimental) Maximum number of instances that are allowed for the fleet.

A fleet's instance maximum determines the capacity ceiling during manual or automatic scaling up. This metric is not available when viewing data for fleet metric groups.

Specified by:

metricMaxInstances in interface IFleet

metricMinInstances

@Stability(Experimental)
@NotNull
public final Metric metricMinInstances(@Nullable
 MetricOptions props)

(experimental) Minimum number of instances allowed for the fleet.

A fleet's instance minimum determines the capacity floor during manual or automatic scaling down. This metric is not available when viewing data for fleet metric groups.

Specified by:

metricMinInstances in interface IBuildFleet.Jsii$Default

Specified by:

metricMinInstances in interface IFleet

Specified by:

metricMinInstances in interface IFleet.Jsii$Default

Parameters:

props -

metricMinInstances

@Stability(Experimental)
@NotNull
public final Metric metricMinInstances()

(experimental) Minimum number of instances allowed for the fleet.

A fleet's instance minimum determines the capacity floor during manual or automatic scaling down. This metric is not available when viewing data for fleet metric groups.

Specified by:

metricMinInstances in interface IFleet

metricPercentIdleInstances

@Stability(Experimental)
@NotNull
public final Metric metricPercentIdleInstances(@Nullable
 MetricOptions props)

(experimental) Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances).

This metric can be used for automatic scaling.

Specified by:

metricPercentIdleInstances in interface IBuildFleet.Jsii$Default

Specified by:

metricPercentIdleInstances in interface IFleet

Specified by:

metricPercentIdleInstances in interface IFleet.Jsii$Default

Parameters:

props -

metricPercentIdleInstances

@Stability(Experimental)
@NotNull
public final Metric metricPercentIdleInstances()

(experimental) Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances).

This metric can be used for automatic scaling.

Specified by:

metricPercentIdleInstances in interface IFleet