Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

CreateFleet

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Creates a fleet of compute resources to host your game servers. Use this operation to set up the following types of fleets based on compute type:

Managed EC2 fleet

An EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your game server build is deployed to each fleet instance. Amazon GameLift manages the fleet's instances and controls the lifecycle of game server processes, which host game sessions for players. EC2 fleets can have instances in multiple locations. Each instance in the fleet is designated a Compute.

To create an EC2 fleet, provide these required parameters:

If successful, this operation creates a new fleet resource and places it in NEW status while Amazon GameLift initiates the fleet creation workflow. To debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create a development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished.

When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location.

Managed container fleet

A container fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your container architecture is deployed to each fleet instance based on the fleet configuration. Amazon GameLift manages the containers on each fleet instance and controls the lifecycle of game server processes, which host game sessions for players. Container fleets can have instances in multiple locations. Each container on an instance that runs game server processes is registered as a Compute.

To create a container fleet, provide these required parameters:

If successful, this operation creates a new fleet resource and places it in NEW status while Amazon GameLift initiates the fleet creation workflow.

When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location.

Anywhere fleet

An Anywhere fleet represents compute resources that are not owned or managed by Amazon GameLift. You might create an Anywhere fleet with your local machine for testing, or use one to host game servers with on-premises hardware or other game hosting solutions.

To create an Anywhere fleet, provide these required parameters:

If successful, this operation creates a new fleet resource and places it in ACTIVE status. You can register computes with a fleet in ACTIVE status.

Learn more

Setting up fleets

Setting up a container fleet

Debug fleet creation issues

Multi-location fleets

Request Syntax

{
   "AnywhereConfiguration": { 
      "Cost": "string"
   },
   "BuildId": "string",
   "CertificateConfiguration": { 
      "CertificateType": "string"
   },
   "ComputeType": "string",
   "ContainerGroupsConfiguration": { 
      "ConnectionPortRange": { 
         "FromPort": number,
         "ToPort": number
      },
      "ContainerGroupDefinitionNames": [ "string" ],
      "DesiredReplicaContainerGroupsPerInstance": number
   },
   "Description": "string",
   "EC2InboundPermissions": [ 
      { 
         "FromPort": number,
         "IpRange": "string",
         "Protocol": "string",
         "ToPort": number
      }
   ],
   "EC2InstanceType": "string",
   "FleetType": "string",
   "InstanceRoleArn": "string",
   "InstanceRoleCredentialsProvider": "string",
   "Locations": [ 
      { 
         "Location": "string"
      }
   ],
   "LogPaths": [ "string" ],
   "MetricGroups": [ "string" ],
   "Name": "string",
   "NewGameSessionProtectionPolicy": "string",
   "PeerVpcAwsAccountId": "string",
   "PeerVpcId": "string",
   "ResourceCreationLimitPolicy": { 
      "NewGameSessionsPerCreator": number,
      "PolicyPeriodInMinutes": number
   },
   "RuntimeConfiguration": { 
      "GameSessionActivationTimeoutSeconds": number,
      "MaxConcurrentGameSessionActivations": number,
      "ServerProcesses": [ 
         { 
            "ConcurrentExecutions": number,
            "LaunchPath": "string",
            "Parameters": "string"
         }
      ]
   },
   "ScriptId": "string",
   "ServerLaunchParameters": "string",
   "ServerLaunchPath": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Response Syntax

{
   "FleetAttributes": { 
      "AnywhereConfiguration": { 
         "Cost": "string"
      },
      "BuildArn": "string",
      "BuildId": "string",
      "CertificateConfiguration": { 
         "CertificateType": "string"
      },
      "ComputeType": "string",
      "ContainerGroupsAttributes": { 
         "ConnectionPortRange": { 
            "FromPort": number,
            "ToPort": number
         },
         "ContainerGroupDefinitionProperties": [ 
            { 
               "ContainerGroupDefinitionName": "string",
               "SchedulingStrategy": "string"
            }
         ],
         "ContainerGroupsPerInstance": { 
            "DesiredReplicaContainerGroupsPerInstance": number,
            "MaxReplicaContainerGroupsPerInstance": number
         }
      },
      "CreationTime": number,
      "Description": "string",
      "FleetArn": "string",
      "FleetId": "string",
      "FleetType": "string",
      "InstanceRoleArn": "string",
      "InstanceRoleCredentialsProvider": "string",
      "InstanceType": "string",
      "LogPaths": [ "string" ],
      "MetricGroups": [ "string" ],
      "Name": "string",
      "NewGameSessionProtectionPolicy": "string",
      "OperatingSystem": "string",
      "ResourceCreationLimitPolicy": { 
         "NewGameSessionsPerCreator": number,
         "PolicyPeriodInMinutes": number
      },
      "ScriptArn": "string",
      "ScriptId": "string",
      "ServerLaunchParameters": "string",
      "ServerLaunchPath": "string",
      "Status": "string",
      "StoppedActions": [ "string" ],
      "TerminationTime": number
   },
   "LocationStates": [ 
      { 
         "Location": "string",
         "Status": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Create fleet with minimal configuration

This example creates an EC2 fleet for a game server build with a minimal configuration and a placeholder launch path. You can use this fleet to create queues and matchmakers, test Amazon GameLift Server API calls, etc. When you're ready to start hosting game sessions, complete the configuration settings using the UpdateFleet operations. If the fleet is in a Region that supports multiple locations, you can add remote locations with CreateFleetLocations later. Note: this example generates a TLS certificate for the fleet, which can only be enabled during fleet creation.

HTTP requests are authenticated using an Amazon Signature Version 4 signature in the Authorization header field.

Sample Request

{
    "Name": "My_Fleet_1",
    "Description": "A minimal sample fleet",
    "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
    "CertificateConfiguration": { 
        "CertificateType": "GENERATED"
    },
    "ComputeType": "EC2",
    "EC2InstanceType": "c4.large",
    "FleetType": "ON_DEMAND",
    "RuntimeConfiguration": {
        "ServerProcesses": [
            {"LaunchPath": "/local/game/mygame.exe",
             "ConcurrentExecutions": 1}
        ]
    }
}

Sample Response

{
    "FleetAttributes": {
        "BuildArn": "arn:aws:gamelift:us-west-2::build/build-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
        "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
        "CertificateConfiguration": { 
            "CertificateType": "GENERATED"
        },
        "ComputeType": "EC2",
        "CreationTime": 1496365885.44, 
        "Description": "A minimal sample fleet",
        "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", 
        "FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", 
        "FleetType": "ON_DEMAND",
        "InstanceType": "c4.large",
        "MetricGroups": [
            "default"
        ],
        "Name": "My_Fleet_1", 
        "NewGameSessionProtectionPolicy": "NoProtection", 
        "OperatingSystem": "AMAZON_LINUX_2023",
        "Status": "NEW"
    }
}

Create fleet with minimal configuration (Windows)

This example creates a fleet for a game server build with a minimal configuration and a placeholder launch path. You can use this fleet to create queues and matchmakers, test Amazon GameLift Server API calls, etc. Once you're ready to start hosting game sessions, complete the configuration settings with the UpdateFleet operations. If the fleet is created in a Region that supports multiple locations, you can add remote locations with CreateFleetLocations later.

HTTP requests are authenticated using an Amazon Signature Version 4 signature in the Authorization header field.

Sample Request

{
    "Name": "My_Fleet_1",
    "Description": "A minimal sample fleet",
    "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
    "ComputeType": "EC2",
    "EC2InstanceType": "c4.large",
    "FleetType": "ON_DEMAND",
    "RuntimeConfiguration": {
        "ServerProcesses": [
            {"LaunchPath": "c:\\game\\mygame.exe",
             "ConcurrentExecutions": 1}
        ]
    }
}

Sample Response

{
    "FleetAttributes": {
        "BuildArn": "arn:aws:gamelift:us-west-2::build/build-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
        "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff", 
        "CertificateConfiguration": { 
            "CertificateType": "DISABLED"
        },
        "ComputeType": "EC2",
        "CreationTime": 1496365885.44, 
        "Description": "A minimal sample fleet",
        "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", 
        "FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", 
        "FleetType": "ON_DEMAND",
        "InstanceType": "c4.large",
        "MetricGroups": [
            "default"
        ],
        "Name": "My_Fleet_1", 
        "NewGameSessionProtectionPolicy": "NoProtection", 
        "OperatingSystem": "WINDOWS_2016",
        "Status": "ACTIVE"
    }
}

Create fleet with full configuration

This example creates an EC2 fleet with complete configuration details. The new fleet, which is created in the Amazon Region us-west-2, also deploys instances to two remote locations. In this example, the runtime configuration defines two server process configurations. The first configuration calls for three concurrent processes of the game server to run in standard mode. The second configuration calls for one process of the game server to run in a test mode. As a result, all fleet instances will maintain a total of four processes concurrently. This example also references an instance role ARN, which allows the processes running on each instance to access other Amazon resources. The example opens port 22 for debugging the fleet. The game server build in this example runs on Windows.

HTTP requests are authenticated using an Amazon Signature Version 4 signature in the Authorization header field.

Sample Request

{
    "Name": "My_Fleet_1",
    "Description": "A fully configured sample fleet with",
    "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
    "CertificateConfiguration": { 
        "CertificateType": "GENERATED"
    },
    "ComputeType": "EC2",
    "EC2InstanceType": "c5.large",
    "EC2InboundPermissions": [
        {"FromPort": 33435,
         "ToPort": 33435,
         "IpRange": "10.24.34.0/23",
         "Protocol": "UDP"}, 
        {"FromPort": 22,
         "ToPort": 22,
         "IpRange": "10.24.34.0/23",
         "Protocol": "TCP"}
    ],
    "FleetType": "ON_DEMAND",
    "Locations": [
        {"Location": "us-east-2"},
        {"Location": "ca-central-1"}
    ],
    "NewGameSessionProtectionPolicy": "FullProtection",
    "RuntimeConfiguration": {
        "ServerProcesses": [
            {"LaunchPath": "c:\\game\\mygame.exe",
             "Parameters": "+map Winter444",
             "ConcurrentExecutions": 3}, 
            {"LaunchPath": "c:\\game\\mygame.exe",
             "Parameters": "-dev -console +map Winter444",
             "ConcurrentExecutions": 1}
        ],
        "MaxConcurrentGameSessionActivations": 2,
        "GameSessionActivationTimeoutSeconds": 300
    },
    "ResourceCreationLimitPolicy": {
        "NewGameSessionsPerCreator": 3,
        "PolicyPeriodInMinutes": 15
    },
    "MetricGroups": ["EMEAfleets"],
    "InstanceRoleArn": "arn:aws:iam::444455556666:role/S3AccessForGameLift",
} 

Sample Response

{
    "FleetAttributes": {
        "BuildArn": "arn:aws:gamelift:us-west-2::build/build-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
        "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff", 
        "CertificateConfiguration": { 
            "CertificateType": "GENERATED"
        },
        "ComputeType": "EC2",
        "CreationTime": 1496375088.502, 
        "Description": "A fully configured sample fleet", 
        "FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", 
        "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
        "FleetType": "ON_DEMAND",
        "InstanceRoleArn": "arn:aws:iam::444455556666:role/S3AccessForGameLift", 
        "MetricGroups": [
            "EMEAfleets"
        ],
        "Name": "My_Fleet_One", 
        "NewGameSessionProtectionPolicy": "FullProtection", 
        "OperatingSystem": "WINDOWS_2016",
        "ResourceCreationLimitPolicy": {
            "NewGameSessionsPerCreator": 3,
            "PolicyPeriodInMinutes": 15
        }
    },
    "LocationStates": [ 
        { 
            "Location": "us-east-2",
            "Status": "NEW"
        },
        { 
            "Location": "ca-central-1",
            "Status": "NEW"
        }
    ]
        "Status": "NEW",
}

Create a container fleet

This example creates a container fleet with a replica container group only. The new fleet deploys instances in the home Amazon Region (us-west-2) and in two remote locations (us-east-2 and ca-central-1). In this example, the container fleet deploys 3 copies of the replica container group per fleet instance. Our runtime configuration instructs the Amazon GameLift Agent to run 5 concurrent server processes in each container group. This means that our new fleet needs at least 15 (3*5) connection ports and preferably double that number. The EC2InboundPermissions property opens all the fleet's connection ports to external traffic.

HTTP requests are authenticated using an Amazon Signature Version 4 signature in the Authorization header field.

Sample Request

{
    "Name": "My_Container_Fleet_1",
    "Description": "A fully configured container fleet",
    "CertificateConfiguration": { 
        "CertificateType": "GENERATED"
    },
    "ComputeType": "CONTAINER",
    "ContainerGroupsConfiguration": {
        "ConnectionPortRange": {
            "FromPort": 1010,
            "ToPort": 1040
        },
        "ContainerGroupDefinitionNames": [ "MegaFrogRaceServer.NA.v2" ],
        "DesiredReplicaContainerGroupsPerInstance": 3
    },
    "EC2InstanceType": "c5.large",
    "EC2InboundPermissions": [
        {"FromPort": 1010,
         "ToPort": 1040,
         "IpRange": "10.24.34.0/23",
         "Protocol": "TCP"} 
        }
    ],
    "FleetType": "ON_DEMAND",
    "NewGameSessionProtectionPolicy": "FullProtection",
    "RuntimeConfiguration": {
        "ServerProcesses": [
            {"LaunchPath": "c:\\game\\mygame.exe",
             "Parameters": "+map Winter444",
             "ConcurrentExecutions": 5}
        ],
        "MaxConcurrentGameSessionActivations": 2,
        "GameSessionActivationTimeoutSeconds": 300
    },
    "ResourceCreationLimitPolicy": {
        "NewGameSessionsPerCreator": 3,
        "PolicyPeriodInMinutes": 15
    },
    "MetricGroups": ["EMEAfleets"],
    "InstanceRoleArn": "arn:aws:iam::444455556666:role/S3AccessForGameLift",
} 

Sample Response

{
    "FleetAttributes": {
        "CertificateConfiguration": { 
            "CertificateType": "GENERATED"
        },
        "ComputeType": "EC2",
        "ContainerGroupsAttributes": {
            "ConnectionPortRange": {
                "FromPort": 1010,
                "ToPort": 1040
            },
            "ContainerGroupDefinitionProperties": [
                {
                    "ContainerGroupDefinitionName": MegaFrogRaceServer.NA.v2",
                    "SchedulingStrategy": "REPLICA"
                }
            ],
            "ContainerGroupsPerInstance": {
                "DesiredReplicaContainerGroupsPerInstance": 5,
                "MaxReplicaContainerGroupsPerInstance": 6
            }
        },
        "CreationTime": 1496375088.502, 
        "Description": "A fully configured sample fleet", 
        "FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", 
        "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
        "FleetType": "ON_DEMAND",
        "InstanceRoleArn": "arn:aws:iam::444455556666:role/S3AccessForGameLift", 
        "MetricGroups": [
            "EMEAfleets"
        ],
        "Name": "My_Container_Fleet_1", 
        "NewGameSessionProtectionPolicy": "FullProtection", 
        "OperatingSystem": "AMAZON_LINUX_2023",
        "ResourceCreationLimitPolicy": {
            "NewGameSessionsPerCreator": 3,
            "PolicyPeriodInMinutes": 15
        }
    },
    "LocationStates": [ 
        { 
            "Location": "us-east-2",
            "Status": "NEW"
        },
        { 
            "Location": "ca-central-1",
            "Status": "NEW"
        }
    ]
        "Status": "NEW",
}

Create a Realtime Servers fleet

This example creates a fleet using a Realtime script that has been uploaded to Amazon GameLift. All Realtime servers are deployed onto Linux machines. This example represents a simple yet complete fleet configuration. You can change configuration settings with the UpdateRuntimeConfiguration operation. The new fleet, which is created in the Amazon Region us-west-2, also deploys instances to two remote locations.

In this example, the uploaded Realtime script includes multiple script files, with the Init() function located in the script file called "myMainScript.js". This file is identified as the launch script in the runtime configuration.

Sample Request

{
    "Name": "My_Realtime_Fleet_1",
    "Description": "A complete Realtime sample fleet",
    "CertificateConfiguration": { 
        "CertificateType": "GENERATED"
    },
    "EC2InstanceType": "c4.large",
    "FleetType": "SPOT",
    "ComputeType": "EC2",
    "Locations": [
        {"Location": "us-east-2"},
        {"Location": "ca-central-1"}
    ],
    "RuntimeConfiguration": {
        "ServerProcesses": [
            {"LaunchPath": "/local/game/myMainScript.js",
             "Parameters": "+map Winter444",
             "ConcurrentExecutions": 5}
        ]
    },
    "ScriptId": "script-1111aaaa-22bb-33cc-44dd-5555eeee66ff"
}

Sample Response

{
    "FleetAttributes": {
        "CertificateConfiguration": { 
            "CertificateType": "GENERATED"
        },
        "ComputeType": "EC2",
        "CreationTime": 1496375088.502, 
        "Description": "A complete Realtime sample fleet", 
        "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", 
        "FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", 
        "FleetType": "SPOT",
        "MetricGroups": [
            "default"
        ],
        "Name": "My_Realtime_Fleet_1", 
        "NewGameSessionProtectionPolicy": "NoProtection", 
        "OperatingSystem": "AMAZON_LINUX_2023",
        "ScriptArn": "arn:aws:gamelift:us-west-2::script/script-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
        "ScriptId": "script-1111aaaa-22bb-33cc-44dd-5555eeee66ff", 
        "Status": "NEW"
    },
    "LocationStates": [ 
        { 
           "Location": "us-east-2",
           "Status": "NEW"
        },
        { 
           "Location": "ca-central-1",
           "Status": "NEW"
        }
    ]
}

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: