interface CfnFleetProps

Language	Type name
.NET	`Amazon.CDK.AWS.GameLift.CfnFleetProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnFleetProps`
Java	`software.amazon.awscdk.services.gamelift.CfnFleetProps`
Python	`aws_cdk.aws_gamelift.CfnFleetProps`
TypeScript	`aws-cdk-lib` » `aws_gamelift` » `CfnFleetProps`

Properties for defining a CfnFleet.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_gamelift as gamelift } from 'aws-cdk-lib';
const cfnFleetProps: gamelift.CfnFleetProps = {
  name: 'name',

  // the properties below are optional
  anywhereConfiguration: {
    cost: 'cost',
  },
  applyCapacity: 'applyCapacity',
  buildId: 'buildId',
  certificateConfiguration: {
    certificateType: 'certificateType',
  },
  computeType: 'computeType',
  description: 'description',
  desiredEc2Instances: 123,
  ec2InboundPermissions: [{
    fromPort: 123,
    ipRange: 'ipRange',
    protocol: 'protocol',
    toPort: 123,
  }],
  ec2InstanceType: 'ec2InstanceType',
  fleetType: 'fleetType',
  instanceRoleArn: 'instanceRoleArn',
  instanceRoleCredentialsProvider: 'instanceRoleCredentialsProvider',
  locations: [{
    location: 'location',

    // the properties below are optional
    locationCapacity: {
      desiredEc2Instances: 123,
      maxSize: 123,
      minSize: 123,
    },
  }],
  logPaths: ['logPaths'],
  maxSize: 123,
  metricGroups: ['metricGroups'],
  minSize: 123,
  newGameSessionProtectionPolicy: 'newGameSessionProtectionPolicy',
  peerVpcAwsAccountId: 'peerVpcAwsAccountId',
  peerVpcId: 'peerVpcId',
  resourceCreationLimitPolicy: {
    newGameSessionsPerCreator: 123,
    policyPeriodInMinutes: 123,
  },
  runtimeConfiguration: {
    gameSessionActivationTimeoutSeconds: 123,
    maxConcurrentGameSessionActivations: 123,
    serverProcesses: [{
      concurrentExecutions: 123,
      launchPath: 'launchPath',

      // the properties below are optional
      parameters: 'parameters',
    }],
  },
  scalingPolicies: [{
    metricName: 'metricName',
    name: 'name',

    // the properties below are optional
    comparisonOperator: 'comparisonOperator',
    evaluationPeriods: 123,
    location: 'location',
    policyType: 'policyType',
    scalingAdjustment: 123,
    scalingAdjustmentType: 'scalingAdjustmentType',
    status: 'status',
    targetConfiguration: {
      targetValue: 123,
    },
    threshold: 123,
    updateStatus: 'updateStatus',
  }],
  scriptId: 'scriptId',
  serverLaunchParameters: 'serverLaunchParameters',
  serverLaunchPath: 'serverLaunchPath',
};

Properties

Name	Type	Description
name	`string`	A descriptive label that is associated with a fleet.
anywhereConfiguration?	`IResolvable` `\|` `AnywhereConfigurationProperty`	Amazon GameLift Anywhere configuration options.
applyCapacity?	`string`	Current resource capacity settings for managed EC2 fleets and managed container fleets.
buildId?	`string`	A unique identifier for a build to be deployed on the new fleet.
certificateConfiguration?	`IResolvable` `\|` `CertificateConfigurationProperty`	Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.
computeType?	`string`	The type of compute resource used to host your game servers.
description?	`string`	A description for the fleet.
desiredEc2Instances?	`number`	The number of EC2 instances that you want this fleet to host.
ec2InboundPermissions?	`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.
ec2InstanceType?	`string`	The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets.
fleetType?	`string`	Indicates whether to use On-Demand or Spot instances for this fleet.
instanceRoleArn?	`string`	A unique identifier for an IAM role that manages access to your AWS services.
instanceRoleCredentialsProvider?	`string`	Indicates that fleet instances maintain a shared credentials file for the IAM role defined in `InstanceRoleArn` .
locations?	`IResolvable` `\|` `IResolvable` `\|` `LocationConfigurationProperty[]`	A set of remote locations to deploy additional instances to and manage as a multi-location fleet.
logPaths?⚠️	`string[]`	This parameter is no longer used.
maxSize?	`number`	The maximum number of instances that are allowed in the specified fleet location.
metricGroups?	`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.
newGameSessionProtectionPolicy?	`string`	The status of termination protection for active game sessions on the fleet.
peerVpcAwsAccountId?	`string`	Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
peerVpcId?	`string`	A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
resourceCreationLimitPolicy?	`IResolvable` `\|` `ResourceCreationLimitPolicyProperty`	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.
runtimeConfiguration?	`IResolvable` `\|` `RuntimeConfigurationProperty`	Instructions for how to launch and maintain server processes on instances in the fleet.
scalingPolicies?	`IResolvable` `\|` `IResolvable` `\|` `ScalingPolicyProperty[]`	Rule that controls how a fleet is scaled.
scriptId?	`string`	The unique identifier for a Realtime configuration script to be deployed on fleet instances.
serverLaunchParameters?⚠️	`string`	This parameter is no longer used but is retained for backward compatibility.
serverLaunchPath?⚠️	`string`	This parameter is no longer used.

name

Type: string

A descriptive label that is associated with a fleet.

Fleet names do not need to be unique.

anywhereConfiguration?

Type: IResolvable | AnywhereConfigurationProperty (optional)

Amazon GameLift Anywhere configuration options.

applyCapacity?

Type: string (optional)

Current resource capacity settings for managed EC2 fleets and managed container fleets.

For multi-location fleets, location values might refer to a fleet's remote location or its home Region.

Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity

buildId?

Type: string (optional)

A unique identifier for a build to be deployed on the new fleet.

If you are deploying the fleet with a custom game build, you must specify this property. 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.

certificateConfiguration?

Type: IResolvable | CertificateConfigurationProperty (optional)

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

Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the CertificateConfiguration is DISABLED . You can't change this property after you create the fleet.

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.

ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the AWS Certificate Manager User Guide .

computeType?

Type: string (optional)

The type of compute resource used to host your game servers.

EC2 – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting.
ANYWHERE – Game servers and supporting software are deployed to compute resources that you provide and manage. With this compute type, you can also set the AnywhereConfiguration parameter.

description?

Type: string (optional)

A description for the fleet.

desiredEc2Instances?

Type: number (optional)

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.

ec2InboundPermissions?

Type: IResolvable | IResolvable | IpPermissionProperty[] (optional)

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

Set this parameter for managed EC2 fleets. You can leave this parameter empty when creating the fleet, but you must call to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.

ec2InstanceType?

Type: string (optional)

The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets.

Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.

fleetType?

Type: string (optional)

Indicates whether to use On-Demand or Spot instances for this fleet.

By default, this property is set to ON_DEMAND . Learn more about when to use On-Demand versus Spot Instances . This fleet property can't be changed after the fleet is created.

instanceRoleArn?

Type: string (optional)

A unique identifier for an IAM role that manages access to your AWS services.

With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the AWS Management Console . Learn more about using on-box credentials for your game servers at Access external resources from a game server . This attribute is used with fleets where ComputeType is EC2 .

instanceRoleCredentialsProvider?

Type: string (optional)

Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn .

Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other AWS resources from your fleets . This attribute is used with fleets where ComputeType is EC2 .

locations?

Type: IResolvable | IResolvable | LocationConfigurationProperty[] (optional)

A set of remote locations to deploy additional instances to and manage as a multi-location fleet.

Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as us-west-2 , or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting.

logPaths?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string[] (optional)

This parameter is no longer used.

When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()

maxSize?

Type: number (optional)

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

If this parameter is not set, the default is 1.

metricGroups?

Type: string[] (optional)

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)

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

If this parameter is not set, the default is 0.

newGameSessionProtectionPolicy?

Type: string (optional)

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

By default, this property is set to NoProtection .

NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
FullProtection - Game sessions in ACTIVE status cannot be terminated during a scale-down event.

peerVpcAwsAccountId?

Type: string (optional)

Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.

You can find your account ID in the AWS Management Console under account settings.

peerVpcId?

Type: string (optional)

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.

The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console . Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets .

resourceCreationLimitPolicy?

Type: IResolvable | ResourceCreationLimitPolicyProperty (optional)

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.

runtimeConfiguration?

Type: IResolvable | RuntimeConfigurationProperty (optional)

Instructions for how to launch and maintain server processes on instances in the fleet.

The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.

The RuntimeConfiguration parameter is required unless the fleet is being configured using the older parameters ServerLaunchPath and ServerLaunchParameters , which are still supported for backward compatibility.

scalingPolicies?

Type: IResolvable | IResolvable | ScalingPolicyProperty[] (optional)

Rule that controls how a fleet is scaled.

Scaling policies are uniquely identified by the combination of name and fleet ID.

scriptId?

Type: string (optional)

The unique identifier for a Realtime configuration script to be deployed on fleet instances.

You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property cannot be changed later.

You can't use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId . Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId . Alternatively, enter a ScriptId string manually.

serverLaunchParameters?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

This parameter is no longer used but is retained for backward compatibility.

Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.

serverLaunchPath?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

This parameter is no longer used.

Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.