class FleetBase 🔹

Language	Type name
.NET	Amazon.CDK.AWS.GameLift.Alpha.FleetBase
Go	github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#FleetBase
Java	software.amazon.awscdk.services.gamelift.alpha.FleetBase
Python	aws_cdk.aws_gamelift_alpha.FleetBase
TypeScript (source)	@aws-cdk/aws-gamelift-alpha » FleetBase

Implements IConstruct, IDependable, IResource, IFleet, IGrantable, IGameSessionQueueDestination

Extends Resource

Implemented by BuildFleet

Base class for new and imported GameLift fleet.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';
import { aws_iam as iam } from 'aws-cdk-lib';

declare const role: iam.Role;
const fleetBase = gamelift_alpha.FleetBase.fromFleetAttributes(this, 'MyFleetBase', {
  fleetArn: 'fleetArn',
  fleetId: 'fleetId',
  role: role,
});

Initializer

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

Parameters

• scope Construct
• id string
• props ResourceProps

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
fleetArn🔹	string	The ARN of the fleet.
fleetId🔹	string	The Identifier of the fleet.
grantPrincipal🔹	IPrincipal	The principal this GameLift fleet is using.
node🔹	Node	The tree node.
resourceArnForDestination🔹	string	The ARN to put into the destination field of a game session queue.
stack🔹	Stack	The 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 this GameLift fleet is using.

---

node🔹

Type: Node

The tree node.

---

resourceArnForDestination🔹

Type: string

The ARN to put into the destination field of a game session queue.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
addAlias(aliasName, options?)🔹	Defines an alias for this fleet.
addInternalLocation(location)🔹	Adds a remote locations to deploy additional instances to and manage as part of the fleet.
addLocation(region, desiredCapacity?, minSize?, maxSize?)🔹	Adds a remote locations to deploy additional instances to and manage as part of the fleet.
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).
toString()🔹	Returns a string representation of this construct.
protected parseLocationCapacity(capacity?)🔹
protected parseLocations()🔹
protected parseResourceCreationLimitPolicy(props)🔹
protected parseRuntimeConfiguration(props)🔹
protected warnVpcPeeringAuthorizations(scope)🔹
static fromFleetAttributes(scope, id, attrs)🔹	Import an existing fleet from its attributes.

---

addAlias(aliasName, options?)🔹

public addAlias(aliasName: string, options?: AliasOptions): Alias

Parameters

• aliasName string — The name of the alias.
• options AliasOptions — Alias options.

Returns

• Alias

Defines an alias for this fleet.

declare const fleet: gamelift.FleetBase;

fleet.addAlias('Live');

// Is equivalent to

new gamelift.Alias(this, 'AliasLive', {
  aliasName: 'Live',
  fleet: fleet,
});

---

addInternalLocation(location)🔹

public addInternalLocation(location: Location): void

Parameters

• location Location — The location to add.

Adds a remote locations to deploy additional instances to and manage as part of the fleet.

---

addLocation(region, desiredCapacity?, minSize?, maxSize?)🔹

public addLocation(region: string, desiredCapacity?: number, minSize?: number, maxSize?: number): void

Parameters

• region string — The AWS region to add.
• desiredCapacity number
• minSize number
• maxSize number

Adds a remote locations to deploy additional instances to and manage as part of the fleet.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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

• grantee IGrantable
• actions string

Returns

• Grant

Grant the grantee identity permissions to perform actions.

---

metric(metricName, props?)🔹

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

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Return the given named metric for this fleet.

---

metricActiveInstances(props?)🔹

public metricActiveInstances(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

• props MetricOptions

Returns

• Metric

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

• props MetricOptions

Returns

• Metric

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

• props MetricOptions

Returns

• Metric

Number of spot instances that have been interrupted.

---

metricMaxInstances(props?)🔹

public metricMaxInstances(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

• props MetricOptions

Returns

• Metric

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

• props MetricOptions

Returns

• Metric

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

This metric can be used for automatic scaling.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected parseLocationCapacity(capacity?)🔹

protected parseLocationCapacity(capacity?: LocationCapacity): LocationCapacityProperty

Parameters

• capacity LocationCapacity

Returns

• LocationCapacityProperty

---

protected parseLocations()🔹

protected parseLocations(): LocationConfigurationProperty[]

Returns

• LocationConfigurationProperty[]

---

protected parseResourceCreationLimitPolicy(props)🔹

protected parseResourceCreationLimitPolicy(props: FleetProps): ResourceCreationLimitPolicyProperty

Parameters

• props FleetProps

Returns

• ResourceCreationLimitPolicyProperty

---

protected parseRuntimeConfiguration(props)🔹

protected parseRuntimeConfiguration(props: FleetProps): RuntimeConfigurationProperty

Parameters

• props FleetProps

Returns

• RuntimeConfigurationProperty

---

protected warnVpcPeeringAuthorizations(scope)🔹

protected warnVpcPeeringAuthorizations(scope: Construct): void

Parameters

• scope Construct

---

static fromFleetAttributes(scope, id, attrs)🔹

public static fromFleetAttributes(scope: Construct, id: string, attrs: FleetAttributes): IFleet

Parameters

• scope Construct
• id string
• attrs FleetAttributes

Returns

• IFleet

Import an existing fleet from its attributes.