AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::GameLift::ContainerFleet

CfnContainerFleet

Describes an Amazon GameLift Servers managed container fleet.

Import

import { CfnContainerFleet } from 'aws-cdk-lib/aws-gamelift';

Or use the module namespace:

import * as gamelift from 'aws-cdk-lib/aws-gamelift';
// gamelift.CfnContainerFleet

Properties

Configuration passed to the constructor as CfnContainerFleetProps.

fleetRoleArnRequired
string

The unique identifier for an AWS Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers. See [Set up an IAM service role](https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html) . This fleet property can't be changed.

billingTypeOptional
string

Indicates whether the fleet uses On-Demand or Spot instances for this fleet. Learn more about when to use [On-Demand versus Spot Instances](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot) . You can't update this fleet property. By default, this property is set to `ON_DEMAND` .

deploymentConfigurationOptional
IResolvable | DeploymentConfigurationProperty

Set of rules for processing a deployment for a container fleet update.

descriptionOptional
string

A meaningful description of the container fleet.

gameServerContainerGroupDefinitionNameOptional
string

The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.

gameServerContainerGroupsPerInstanceOptional
number

The number of times to replicate the game server container group on each fleet instance.

gameSessionCreationLimitPolicyOptional
IResolvable | GameSessionCreationLimitPolicyProperty

A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.

instanceConnectionPortRangeOptional
IResolvable | ConnectionPortRangeProperty

The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.

instanceInboundPermissionsOptional
IResolvable | IResolvable | IpPermissionProperty[]

The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.

instanceTypeOptional
string

The Amazon EC2 instance type to use for all instances in the fleet. Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity. You can't update this fleet property.

locationsOptional
IResolvable | IResolvable | LocationConfigurationProperty[]
logConfigurationOptional
IResolvable | LogConfigurationProperty

The method that is used to collect container logs for the fleet. Amazon GameLift Servers saves all standard output for each container in logs, including game session logs. - `CLOUDWATCH` -- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group. - `S3` -- Store logs in an Amazon S3 bucket that you define. - `NONE` -- Don't collect container logs.

metricGroupsOptional
string[]

The name of an AWS CloudWatch metric group to add this fleet to. Metric groups aggregate metrics for multiple fleets.

newGameSessionProtectionPolicyOptional
string

Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift Servers might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using [UpdateGameSession](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html) . - *NoProtection* -- Game sessions can be shut down during active gameplay. - *FullProtection* -- Game sessions in `ACTIVE` status can't be shut down.

perInstanceContainerGroupDefinitionNameOptional
string

The name of the fleet's per-instance container group definition.

playerGatewayModeOptional
string

The player gateway mode for the container fleet.

scalingPoliciesOptional
IResolvable | IResolvable | ScalingPolicyProperty[]

A list of rules that control how a fleet is scaled.

tagsOptional
CfnTag[]

An array of key-value pairs to apply to this resource.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter