class BuildFleet (construct) 🔹

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

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

A fleet contains Amazon Elastic Compute Cloud (Amazon EC2) instances that GameLift hosts.

A fleet uses the configuration and scaling logic that you define to run your game server build. You can use a fleet directly without a queue. You can also associate multiple fleets with a GameLift queue.

For example, you can use Spot Instance fleets configured with your preferred locations, along with a backup On-Demand Instance fleet with the same locations. Using multiple Spot Instance fleets of different instance types reduces the chance of needing On-Demand Instance placement.

Example

declare const build: gamelift.Build;
// Server processes can be delcared in a declarative way through the constructor
const fleet = new gamelift.BuildFleet(this, 'Game server fleet', {
  fleetName: 'test-fleet',
  content: build,
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),
  runtimeConfiguration: {
    serverProcesses: [{
      launchPath: '/local/game/GameLiftExampleServer.x86_64',
      parameters: '-logFile /local/game/logs/myserver1935.log -port 1935',
      concurrentExecutions: 100,
    }]
  }
});

Initializer

new BuildFleet(scope: Construct, id: string, props: BuildFleetProps)

Parameters

• scope Construct
• id string
• props BuildFleetProps

Construct Props

Name	Type	Description
content🔹	IBuild	A build to be deployed on the fleet.
fleetName🔹	string	A descriptive label that is associated with a fleet.
instanceType🔹	InstanceType	The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
runtimeConfiguration🔹	RuntimeConfiguration	A collection of server process configurations that describe the set of processes to run on each instance in a fleet.
description?🔹	string	A human-readable description of the fleet.
desiredCapacity?🔹	number	The number of EC2 instances that you want this fleet to host.
ingressRules?🔹	IngressRule[]	The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.
locations?🔹	Location[]	A set of remote locations to deploy additional instances to and manage as part of the fleet.
maxSize?🔹	number	The maximum number of instances that are allowed in the specified fleet location.
metricGroup?🔹	string	The name of an AWS CloudWatch metric group to add this fleet to.
minSize?🔹	number	The minimum number of instances that are allowed in the specified fleet location.
peerVpc?🔹	IVpc	A VPC peering connection between your GameLift-hosted game servers and your other non-GameLift resources.
protectNewGameSession?🔹	boolean	The status of termination protection for active game sessions on the fleet.
resourceCreationLimitPolicy?🔹	ResourceCreationLimitPolicy	A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.
role?🔹	IRole	The IAM role assumed by GameLift fleet instances to access AWS ressources.
useCertificate?🔹	boolean	Prompts GameLift to generate a TLS/SSL certificate for the fleet.
useSpot?🔹	boolean	Indicates whether to use On-Demand or Spot instances for this fleet. By default, fleet use on demand capacity.

---

content🔹

Type: IBuild

A build to be deployed on the fleet.

The build must have been successfully uploaded to Amazon GameLift and be in a READY status.

This fleet setting cannot be changed once the fleet is created.

---

fleetName🔹

Type: string

A descriptive label that is associated with a fleet.

Fleet names do not need to be unique.

---

instanceType🔹

Type: InstanceType

The GameLift-supported Amazon EC2 instance type to use for all fleet instances.

Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity.

See also: [http://aws.amazon.com/ec2/instance-types/ for detailed descriptions of Amazon EC2 instance types.](http://aws.amazon.com/ec2/instance-types/ for detailed descriptions of Amazon EC2 instance types.)

---

runtimeConfiguration🔹

Type: RuntimeConfiguration

A collection of server process configurations that describe the set of processes to run on each instance in a fleet.

Server processes run either an executable in a custom game build or a Realtime Servers script. GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration.

A GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess.

See also: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html

---

description?🔹

Type: string (optional, default: no description is provided)

A human-readable description of the fleet.

---

desiredCapacity?🔹

Type: number (optional, default: Default capacity is 0)

The number of EC2 instances that you want this fleet to host.

When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.

---

ingressRules?🔹

Type: IngressRule[] (optional, default: no inbound traffic allowed)

The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.

This property must be set before players can connect to game sessions.

---

locations?🔹

Type: Location[] (optional, default: Create a fleet with instances in the home region only)

A set of remote locations to deploy additional instances to and manage as part of the fleet.

This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as us-west-2. To create a fleet with instances in the home region only, omit this parameter.

---

maxSize?🔹

Type: number (optional, default: the default is 1)

The maximum number of instances that are allowed in the specified fleet location.

---

metricGroup?🔹

Type: string (optional, default: Fleet metrics are aggregated with other fleets in the default metric group)

The name of an AWS CloudWatch metric group to add this fleet to.

A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.

---

minSize?🔹

Type: number (optional, default: the default is 0)

The minimum number of instances that are allowed in the specified fleet location.

---

peerVpc?🔹

Type: IVpc (optional, default: no vpc peering)

A VPC peering connection between your GameLift-hosted game servers and your other non-GameLift resources.

Use Amazon Virtual Private Cloud (VPC) peering connections to enable your game servers to communicate directly and privately with your other AWS resources, such as a web service or a repository. You can establish VPC peering with any resources that run on AWS and are managed by an AWS account that you have access to. The VPC must be in the same Region as your fleet.

Warning: Be sure to create a VPC Peering authorization through Gamelift Service API.

See also: https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html

---

protectNewGameSession?🔹

Type: boolean (optional, default: true - Game sessions in ACTIVE status cannot be terminated during a scale-down event.)

The status of termination protection for active game sessions on the fleet.

By default, new game sessions are protected and cannot be terminated during a scale-down event.

---

resourceCreationLimitPolicy?🔹

Type: ResourceCreationLimitPolicy (optional, default: No resource creation limit policy)

A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.

---

role?🔹

Type: IRole (optional, default: a role will be created with default trust to Gamelift service principal.)

The IAM role assumed by GameLift fleet instances to access AWS ressources.

With a role set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). If providing a custom role, it needs to trust the GameLift service principal (gamelift.amazonaws.com). No permission is required by default.

This property cannot be changed after the fleet is created.

See also: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html

---

useCertificate?🔹

Type: boolean (optional, default: TLS/SSL certificate are generated for the fleet)

Prompts GameLift to generate a TLS/SSL certificate for the fleet.

GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift.

You can't change this property after you create the fleet.

Additionnal info: AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.

---

useSpot?🔹

Type: boolean (optional, default: Gamelift fleet use on demand capacity)

Indicates whether to use On-Demand or Spot instances for this fleet. By default, fleet use on demand capacity.

This property cannot be changed after the fleet is created.

See also: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot

Properties

Name	Type	Description
content🔹	IBuild	The build content of the fleet.
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.
role🔹	IRole	The IAM role GameLift assumes by fleet instances to access AWS ressources.
stack🔹	Stack	The stack in which this resource is defined.

---

content🔹

Type: IBuild

The build content of the fleet.

---

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.

---

role🔹

Type: IRole

The IAM role GameLift assumes by fleet instances to access AWS ressources.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
addAlias(aliasName, options?)🔹	Defines an alias for this fleet.
addIngressRule(source, port)🔹	Adds an ingress rule to allow inbound traffic to access game sessions on 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.
static fromBuildFleetArn(scope, id, buildFleetArn)🔹	Import an existing fleet from its ARN.
static fromBuildFleetId(scope, id, buildFleetId)🔹	Import an existing fleet from its identifier.

---

addAlias(aliasName, options?)🔹

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

Parameters

• aliasName string  1¤7 The name of the alias.
• options AliasOptions  1¤7 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,
});

---

addIngressRule(source, port)🔹

public addIngressRule(source: IPeer, port: Port): void

Parameters

• source IPeer  1¤7 A range of allowed IP addresses.
• port Port  1¤7 The port range used for ingress traffic.

Adds an ingress rule to allow inbound traffic to access game sessions on this fleet.

---

addInternalLocation(location)🔹

public addInternalLocation(location: Location): void

Parameters

• location Location  1¤7 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  1¤7 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.

---

static fromBuildFleetArn(scope, id, buildFleetArn)🔹

public static fromBuildFleetArn(scope: Construct, id: string, buildFleetArn: string): IBuildFleet

Parameters

• scope Construct
• id string
• buildFleetArn string

Returns

• IBuildFleet

Import an existing fleet from its ARN.

---

static fromBuildFleetId(scope, id, buildFleetId)🔹

public static fromBuildFleetId(scope: Construct, id: string, buildFleetId: string): IBuildFleet

Parameters

• scope Construct
• id string
• buildFleetId string

Returns

• IBuildFleet

Import an existing fleet from its identifier.