AWS::GameLift::Fleet

The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 instances, each of which is a host in the fleet. For more information, see the CreateFleet action in the Amazon GameLift API Reference.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON


{
  "Type" : "AWS::GameLift::Fleet",
  "Properties" : {
      "BuildId" : String,
      "Description" : String,
      "DesiredEC2Instances" : Integer,
      "EC2InboundPermissions" : [ IpPermission, ... ],
      "EC2InstanceType" : String,
      "LogPaths" : [ String, ... ],
      "MaxSize" : Integer,
      "MinSize" : Integer,
      "Name" : String,
      "ServerLaunchParameters" : String,
      "ServerLaunchPath" : String
    }
}

YAML


Type: AWS::GameLift::Fleet
Properties: 
  BuildId: String
  Description: String
  DesiredEC2Instances: Integer
  EC2InboundPermissions: 
    - IpPermission
  EC2InstanceType: String
  LogPaths: 
    - String
  MaxSize: Integer
  MinSize: Integer
  Name: String
  ServerLaunchParameters: String
  ServerLaunchPath: String

Properties

BuildId

A unique identifier for a build to be deployed on the new fleet. The custom game server 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.

Required: Yes

Type: String

Pattern: ^build-\S+

Update requires: Replacement

Description

A human-readable description of a fleet.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

DesiredEC2Instances

Number of EC2 instances you want this fleet to host.

Required: Yes

Type: Integer

Minimum: 0

Update requires: No interruption

EC2InboundPermissions

Range of IP addresses and port settings that permit inbound traffic to access game sessions that are running on the fleet. For fleets using a custom game build, this parameter is required before game sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission settings or add more by updating the fleet.

Required: No

Type: List of IpPermission

Maximum: 50

Update requires: No interruption

EC2InstanceType

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. For more information about the instance types that are supported by GameLift, see the EC2InstanceType parameter in the Amazon GameLift API Reference.

Required: Yes

Type: String

Update requires: Replacement

LogPaths

This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

Required: No

Type: List of String

Update requires: Replacement

MaxSize

The maximum value allowed for the fleet's instance count. Default if not set is 1.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption

MinSize

The minimum value allowed for the fleet's instance count. Default if not set is 0.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption

Name

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Required: Yes

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

ServerLaunchParameters

The parameters that are required to launch your game server. Specify these parameters as a string of command-line parameters, such as +sv_port 33435 +start_lobby.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: Replacement

ServerLaunchPath

The location of your game server that GameLift launches. You must escape the slashes (\) and use the following pattern: C:\\game\\launchpath. For example, if your game server files are in the MyGame folder, the path should be C:\\game\\MyGame\\server.exe.

Required: Yes

Type: String

Minimum: 1

Maximum: 1024

Update requires: Replacement

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the fleet ID, such as myfleet-a01234b56-7890-1de2-f345-g67h8i901j2k.

For more information about using the Ref function, see Ref.

Examples

Create GameLift fleet

The following example creates a GameLift fleet named MyGameFleet with two inbound permissions. The fleet uses a Ref intrinsic function to specify a build, which can be declared elsewhere in the same template. For the log path and server launch path, the example uses the escape character (\) to escape the slashes (\).

JSON


"FleetResource": {
  "Type": "AWS::GameLift::Fleet",
  "Properties": {
    "Name": "MyGameFleet",
    "Description": "A fleet for my game",
    "BuildId": { "Ref": "BuildResource" },
    "ServerLaunchPath": "c:\\game\\TestApplicationServer.exe",
    "LogPaths": [
      "c:\\game\\testlog.log",
      "c:\\game\\testlog2.log"
    ],
    "EC2InstanceType": "t2.small",
    "DesiredEC2Instances": "2",
    "EC2InboundPermissions": [
      {
        "FromPort": "1234",
        "ToPort": "1324",
        "IpRange": "0.0.0.0/24",
        "Protocol": "TCP"
      },
      {
        "FromPort": "1356",
        "ToPort": "1578",
        "IpRange": "192.168.0.0/24",
        "Protocol": "UDP"
      }
    ]
  } 
}

YAML


FleetResource: 
  Type: AWS::GameLift::Fleet
  Properties: 
    Name: "MyGameFleet"
    Description: "A fleet for my game"
    BuildId: 
      Ref: "BuildResource"
    ServerLaunchPath: "c:\\game\\TestApplicationServer.exe"
    LogPaths: 
      - "c:\\game\\testlog.log"
      - "c:\\game\\testlog2.log"
    EC2InstanceType: "t2.small"
    DesiredEC2Instances: "2"
    EC2InboundPermissions: 
      - 
        FromPort: "1234"
        ToPort: "1324"
        IpRange: "0.0.0.0/24"
        Protocol: "TCP"
      - 
        FromPort: "1356"
        ToPort: "1578"
        IpRange: "192.168.0.0/24"
        Protocol: "UDP"

AWS::GameLift::Fleet

Syntax

JSON

YAML

Properties

Return Values

Ref

Examples

Create GameLift fleet

JSON

YAML

See Also