2.170.0

interface IFleet 🔹

LanguageType name
.NETAmazon.CDK.AWS.GameLift.Alpha.IFleet
Gogithub.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#IFleet
Javasoftware.amazon.awscdk.services.gamelift.alpha.IFleet
Pythonaws_cdk.aws_gamelift_alpha.IFleet
TypeScript (source)@aws-cdk/aws-gamelift-alpha » IFleet

Implemented by BuildFleet

Obtainable from FleetBase.fromFleetAttributes()

Represents a Gamelift fleet.

Properties

NameTypeDescription
env🔹ResourceEnvironmentThe environment this resource belongs to.
fleetArn🔹stringThe ARN of the fleet.
fleetId🔹stringThe Identifier of the fleet.
grantPrincipal🔹IPrincipalThe principal to grant permissions to.
node🔹NodeThe tree node.
resourceArnForDestination🔹stringThe ARN(s) to put into the destination field for a game session queue.
stack🔹StackThe stack in which this resource is defined.

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

fleetArn🔹

Type: string

The ARN of the fleet.

fleetId🔹

Type: string

The Identifier of the fleet.

grantPrincipal🔹

Type: IPrincipal

The principal to grant permissions to.

node🔹

Type: Node

The tree node.

resourceArnForDestination🔹

Type: string

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.

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)🔹Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹Grant the grantee identity permissions to perform actions.
metric(metricName, props?)🔹Return the given named metric for this fleet.
metricActiveInstances(props?)🔹Instances with ACTIVE status, which means they are running active server processes.
metricDesiredInstances(props?)🔹Target number of active instances that GameLift is working to maintain in the fleet.
metricIdleInstances(props?)🔹Active instances that are currently hosting zero (0) game sessions.
metricInstanceInterruptions(props?)🔹Number of spot instances that have been interrupted.
metricMaxInstances(props?)🔹Maximum number of instances that are allowed for the fleet.
metricMinInstances(props?)🔹Minimum number of instances allowed for the fleet.
metricPercentIdleInstances(props?)🔹Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances).

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

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

grant(grantee, ...actions)🔹

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

Returns

Grant the grantee identity permissions to perform actions.

metric(metricName, props?)🔹

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

Returns

Return the given named metric for this fleet.

metricActiveInstances(props?)🔹

public metricActiveInstances(props?: MetricOptions): Metric

Parameters

Returns

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(props?)🔹

public metricDesiredInstances(props?: MetricOptions): Metric

Parameters

Returns

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(props?)🔹

public metricIdleInstances(props?: MetricOptions): Metric

Parameters

Returns

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(props?)🔹

public metricInstanceInterruptions(props?: MetricOptions): Metric

Parameters

Returns

Number of spot instances that have been interrupted.

metricMaxInstances(props?)🔹

public metricMaxInstances(props?: MetricOptions): Metric

Parameters

Returns

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(props?)🔹

public metricMinInstances(props?: MetricOptions): Metric

Parameters

Returns

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(props?)🔹

public metricPercentIdleInstances(props?: MetricOptions): Metric

Parameters

Returns

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

This metric can be used for automatic scaling.

← PreviousNext →