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

Interface IFleet

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IGameSessionQueueDestination, IGrantable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IBuildFleet, IBuildFleet.Jsii$Default, IFleet.Jsii$Default

All Known Implementing Classes:

BuildFleet, FleetBase, IBuildFleet.Jsii$Proxy, IFleet.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-29T22:54:27.713Z")
@Stability(Experimental)
public interface IFleet
extends software.amazon.jsii.JsiiSerializable, IResource, IGrantable, IGameSessionQueueDestination

(experimental) Represents a Gamelift fleet.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IFleet.Jsii$Default	Internal default implementation for IFleet.
static final class	IFleet.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getFleetArn()	(experimental) The ARN of the fleet.
String	getFleetId()	(experimental) The Identifier of the fleet.
Grant	grant(IGrantable grantee, @NotNull String... actions)	(experimental) Grant the grantee identity permissions to perform actions.
Metric	metric(String metricName)	(experimental) Return the given named metric for this fleet.
Metric	metric(String metricName, MetricOptions props)	(experimental) Return the given named metric for this fleet.
Metric	metricActiveInstances()	(experimental) Instances with ACTIVE status, which means they are running active server processes.
Metric	metricActiveInstances(MetricOptions props)	(experimental) Instances with ACTIVE status, which means they are running active server processes.
Metric	metricDesiredInstances()	(experimental) Target number of active instances that GameLift is working to maintain in the fleet.
Metric	metricDesiredInstances(MetricOptions props)	(experimental) Target number of active instances that GameLift is working to maintain in the fleet.
Metric	metricIdleInstances()	(experimental) Active instances that are currently hosting zero (0) game sessions.
Metric	metricIdleInstances(MetricOptions props)	(experimental) Active instances that are currently hosting zero (0) game sessions.
Metric	metricInstanceInterruptions()	(experimental) Number of spot instances that have been interrupted.
Metric	metricInstanceInterruptions(MetricOptions props)	(experimental) Number of spot instances that have been interrupted.
Metric	metricMaxInstances()	(experimental) Maximum number of instances that are allowed for the fleet.
Metric	metricMaxInstances(MetricOptions props)	(experimental) Maximum number of instances that are allowed for the fleet.
Metric	metricMinInstances()	(experimental) Minimum number of instances allowed for the fleet.
Metric	metricMinInstances(MetricOptions props)	(experimental) Minimum number of instances allowed for the fleet.
Metric	metricPercentIdleInstances()	(experimental) Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances).
Metric	metricPercentIdleInstances(MetricOptions props)	(experimental) Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances).

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.services.gamelift.alpha.IGameSessionQueueDestination

getResourceArnForDestination

Methods inherited from interface software.amazon.awscdk.services.iam.IGrantable

getGrantPrincipal

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFleetArn

@Stability(Experimental)
@NotNull
String getFleetArn()

(experimental) The ARN of the fleet.

getFleetId

@Stability(Experimental)
@NotNull
String getFleetId()

(experimental) The Identifier of the fleet.

grant

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

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

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

metric

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

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

Parameters:

metricName - This parameter is required.

props -

metric

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

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

Parameters:

metricName - This parameter is required.

metricActiveInstances

@Stability(Experimental)
@NotNull
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.

Parameters:

props -

metricActiveInstances

@Stability(Experimental)
@NotNull
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.

metricDesiredInstances

@Stability(Experimental)
@NotNull
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.

Parameters:

props -

metricDesiredInstances

@Stability(Experimental)
@NotNull
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.

metricIdleInstances

@Stability(Experimental)
@NotNull
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.

Parameters:

props -

metricIdleInstances

@Stability(Experimental)
@NotNull
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.

metricInstanceInterruptions

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

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

Parameters:

props -

metricInstanceInterruptions

@Stability(Experimental)
@NotNull
Metric metricInstanceInterruptions()

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

metricMaxInstances

@Stability(Experimental)
@NotNull
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.

Parameters:

props -

metricMaxInstances

@Stability(Experimental)
@NotNull
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.

metricMinInstances

@Stability(Experimental)
@NotNull
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.

Parameters:

props -

metricMinInstances

@Stability(Experimental)
@NotNull
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.

metricPercentIdleInstances

@Stability(Experimental)
@NotNull
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.

Parameters:

props -

metricPercentIdleInstances

@Stability(Experimental)
@NotNull
Metric metricPercentIdleInstances()

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

This metric can be used for automatic scaling.