Interface IFleet

(experimental) Represents a Gamelift fleet.

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Stack

IEnvironmentAware.Env

IGrantable.GrantPrincipal

IGameSessionQueueDestination.ResourceArnForDestination

Namespace: Amazon.CDK.AWS.GameLift.Alpha

Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll

Syntax (csharp)

public interface IFleet : IResource, IConstruct, IDependable, IEnvironmentAware, IGrantable, IGameSessionQueueDestination

Syntax (vb)

Public Interface IFleet Inherits IResource, IConstruct, IDependable, IEnvironmentAware, IGrantable, IGameSessionQueueDestination

Remarks

Stability: Experimental

Synopsis

Properties

FleetArn	(experimental) The ARN of the fleet.
FleetId	(experimental) The Identifier of the fleet.

Methods

Grant(IGrantable, params string[])	(experimental) Grant the grantee identity permissions to perform actions.
Metric(string, IMetricOptions?)	(experimental) Return the given named metric for this fleet.
MetricActiveInstances(IMetricOptions?)	(experimental) Instances with ACTIVE status, which means they are running active server processes.
MetricDesiredInstances(IMetricOptions?)	(experimental) Target number of active instances that GameLift is working to maintain in the fleet.
MetricIdleInstances(IMetricOptions?)	(experimental) Active instances that are currently hosting zero (0) game sessions.
MetricInstanceInterruptions(IMetricOptions?)	(experimental) Number of spot instances that have been interrupted.
MetricMaxInstances(IMetricOptions?)	(experimental) Maximum number of instances that are allowed for the fleet.
MetricMinInstances(IMetricOptions?)	(experimental) Minimum number of instances allowed for the fleet.
MetricPercentIdleInstances(IMetricOptions?)	(experimental) Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances).

Properties

FleetArn

(experimental) The ARN of the fleet.

string FleetArn { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

FleetId

(experimental) The Identifier of the fleet.

string FleetId { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

Methods

Grant(IGrantable, params string[])

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

Grant Grant(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable

actions string[]

Returns

Grant

Remarks

Stability: Experimental

Metric(string, IMetricOptions?)

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

Metric Metric(string metricName, IMetricOptions? props = null)

Parameters

metricName string

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricActiveInstances(IMetricOptions?)

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

Metric MetricActiveInstances(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

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.

Stability: Experimental

MetricDesiredInstances(IMetricOptions?)

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

Metric MetricDesiredInstances(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

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.

Stability: Experimental

MetricIdleInstances(IMetricOptions?)

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

Metric MetricIdleInstances(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

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

Stability: Experimental

MetricInstanceInterruptions(IMetricOptions?)

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

Metric MetricInstanceInterruptions(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricMaxInstances(IMetricOptions?)

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

Metric MetricMaxInstances(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

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.

Stability: Experimental

MetricMinInstances(IMetricOptions?)

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

Metric MetricMinInstances(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

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.

Stability: Experimental

MetricPercentIdleInstances(IMetricOptions?)

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

Metric MetricPercentIdleInstances(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

This metric can be used for automatic scaling.

Stability: Experimental