[ aws . gamelift ]

create-fleet

Description

Creates a new fleet to run your game servers. whether they are custom game builds or Realtime Servers with game-specific script. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can host multiple game sessions. When creating a fleet, you choose the hardware specifications, set some configuration options, and specify the game server to deploy on the new fleet.

To create a new fleet, provide the following: (1) a fleet name, (2) an EC2 instance type and fleet type (spot or on-demand), (3) the build ID for your game build or script ID if using Realtime Servers, and (4) a runtime configuration, which determines how game servers will run on each instance in the fleet.

If the CreateFleet call is successful, Amazon GameLift performs the following tasks. You can track the process of a fleet by checking the fleet status or by monitoring fleet creation events:

  • Creates a fleet resource. Status: NEW .

  • Begins writing events to the fleet event log, which can be accessed in the Amazon GameLift console.

  • Sets the fleet’s target capacity to 1 (desired instances), which triggers Amazon GameLift to start one new EC2 instance.

  • Downloads the game build or Realtime script to the new instance and installs it. Statuses: DOWNLOADING , VALIDATING , BUILDING .

  • Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, Amazon GameLift staggers each process launch by a few seconds. Status: ACTIVATING .

  • Sets the fleet’s status to ACTIVE as soon as one server process is ready to host a game session.

Learn more

Setting Up Fleets

Debug Fleet Creation Issues

Related operations

  • CreateFleet

  • ListFleets

  • DeleteFleet

  • DescribeFleetAttributes

  • UpdateFleetAttributes

  • StartFleetActions or StopFleetActions

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-fleet
--name <value>
[--description <value>]
[--build-id <value>]
[--script-id <value>]
[--server-launch-path <value>]
[--server-launch-parameters <value>]
[--log-paths <value>]
--ec2-instance-type <value>
[--ec2-inbound-permissions <value>]
[--new-game-session-protection-policy <value>]
[--runtime-configuration <value>]
[--resource-creation-limit-policy <value>]
[--metric-groups <value>]
[--peer-vpc-aws-account-id <value>]
[--peer-vpc-id <value>]
[--fleet-type <value>]
[--instance-role-arn <value>]
[--certificate-configuration <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--name (string)

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

--description (string)

A human-readable description of a fleet.

--build-id (string)

A unique identifier for a build to be deployed on the new fleet. You can use either the build ID or ARN value. 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.

--script-id (string)

A unique identifier for a Realtime script to be deployed on the new fleet. You can use either the script ID or ARN value. The Realtime script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.

--server-launch-path (string)

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.

--server-launch-parameters (string)

This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.)

--log-paths (list)

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 .

(string)

Syntax:

"string" "string" ...

--ec2-instance-type (string)

The 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. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Possible values:

  • t2.micro

  • t2.small

  • t2.medium

  • t2.large

  • c3.large

  • c3.xlarge

  • c3.2xlarge

  • c3.4xlarge

  • c3.8xlarge

  • c4.large

  • c4.xlarge

  • c4.2xlarge

  • c4.4xlarge

  • c4.8xlarge

  • c5.large

  • c5.xlarge

  • c5.2xlarge

  • c5.4xlarge

  • c5.9xlarge

  • c5.12xlarge

  • c5.18xlarge

  • c5.24xlarge

  • r3.large

  • r3.xlarge

  • r3.2xlarge

  • r3.4xlarge

  • r3.8xlarge

  • r4.large

  • r4.xlarge

  • r4.2xlarge

  • r4.4xlarge

  • r4.8xlarge

  • r4.16xlarge

  • r5.large

  • r5.xlarge

  • r5.2xlarge

  • r5.4xlarge

  • r5.8xlarge

  • r5.12xlarge

  • r5.16xlarge

  • r5.24xlarge

  • m3.medium

  • m3.large

  • m3.xlarge

  • m3.2xlarge

  • m4.large

  • m4.xlarge

  • m4.2xlarge

  • m4.4xlarge

  • m4.10xlarge

  • m5.large

  • m5.xlarge

  • m5.2xlarge

  • m5.4xlarge

  • m5.8xlarge

  • m5.12xlarge

  • m5.16xlarge

  • m5.24xlarge

--ec2-inbound-permissions (list)

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.

(structure)

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet’s allowed ranges. For fleets created with a custom game server, the ranges reflect the server’s game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP for use by the Realtime servers.

FromPort -> (integer)

A starting value for a range of allowed port numbers.

ToPort -> (integer)

An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort .

IpRange -> (string)

A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: “000.000.000.000/[subnet mask] ” or optionally the shortened version “0.0.0.0/[subnet mask] “.

Protocol -> (string)

The network communication protocol used by the fleet.

Shorthand Syntax:

FromPort=integer,ToPort=integer,IpRange=string,Protocol=string ...

JSON Syntax:

[
  {
    "FromPort": integer,
    "ToPort": integer,
    "IpRange": "string",
    "Protocol": "TCP"|"UDP"
  }
  ...
]

--new-game-session-protection-policy (string)

A game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet’s protection policy using UpdateFleetAttributes , but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession .

  • NoProtection - The game session can be terminated during a scale-down event.

  • FullProtection - If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Possible values:

  • NoProtection

  • FullProtection

--runtime-configuration (structure)

Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters , although requests that contain values for these parameters instead of a runtime configuration will continue to work.) This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration replaced these parameters, but fleets that use them will continue to work.

ServerProcesses -> (list)

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

(structure)

A set of instructions for launching server processes on each instance in a fleet. Server processes run either a custom game build executable or a Realtime Servers script. Each instruction set identifies the location of the custom game build executable or Realtime launch script, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet’s `` RuntimeConfiguration `` .

LaunchPath -> (string)

The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

  • Windows (for custom game builds only): C:\game . Example: “C:\game\MyGame\server.exe

  • Linux: /local/game . Examples: “/local/game/MyGame/server.exe ” or “/local/game/MyRealtimeScript.js

Parameters -> (string)

An optional list of parameters to pass to the server executable or Realtime script on launch.

ConcurrentExecutions -> (integer)

The number of server processes that use this configuration to run concurrently on an instance.

MaxConcurrentGameSessionActivations -> (integer)

The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.

GameSessionActivationTimeoutSeconds -> (integer)

The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING . If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED .

Shorthand Syntax:

ServerProcesses=[{LaunchPath=string,Parameters=string,ConcurrentExecutions=integer},{LaunchPath=string,Parameters=string,ConcurrentExecutions=integer}],MaxConcurrentGameSessionActivations=integer,GameSessionActivationTimeoutSeconds=integer

JSON Syntax:

{
  "ServerProcesses": [
    {
      "LaunchPath": "string",
      "Parameters": "string",
      "ConcurrentExecutions": integer
    }
    ...
  ],
  "MaxConcurrentGameSessionActivations": integer,
  "GameSessionActivationTimeoutSeconds": integer
}

--resource-creation-limit-policy (structure)

A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

NewGameSessionsPerCreator -> (integer)

The maximum number of game sessions that an individual can create during the policy period.

PolicyPeriodInMinutes -> (integer)

The time span used in evaluating the resource creation limit policy.

Shorthand Syntax:

NewGameSessionsPerCreator=integer,PolicyPeriodInMinutes=integer

JSON Syntax:

{
  "NewGameSessionsPerCreator": integer,
  "PolicyPeriodInMinutes": integer
}

--metric-groups (list)

The name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new metric group. A fleet can only be included in one metric group at a time.

(string)

Syntax:

"string" "string" ...

--peer-vpc-aws-account-id (string)

A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.

--peer-vpc-id (string)

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 .

--fleet-type (string)

Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND . Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. Learn more about On-Demand versus Spot Instances .

Possible values:

  • ON_DEMAND

  • SPOT

--instance-role-arn (string)

A unique identifier for an AWS 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 from 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 .

--certificate-configuration (structure)

Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not specified, the default value, DISABLED, is used. This fleet setting cannot be changed once the fleet is created. Learn more at Securing Client/Server Communication .

Note: This feature requires the AWS Certificate Manager (ACM) service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported Region error.

Valid values include:

  • GENERATED - Generate a TLS/SSL certificate for this fleet.

  • DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.

CertificateType -> (string)

Indicates whether a TLS/SSL certificate was generated for a fleet.

Shorthand Syntax:

CertificateType=string

JSON Syntax:

{
  "CertificateType": "DISABLED"|"GENERATED"
}

--tags (list)

A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource , UntagResource , and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

(structure)

A label that can be assigned to a GameLift resource.

Learn more

Tagging AWS Resources in the AWS General Reference

AWS Tagging Strategies

Related operations

  • TagResource

  • UntagResource

  • ListTagsForResource

Key -> (string)

The key for a developer-defined key:value pair for tagging an AWS resource.

Value -> (string)

The value for a developer-defined key:value pair for tagging an AWS resource.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

Example 1: To create a basic Linux fleet

The following create-fleet example creates a minimally configured fleet of on-demand Linux instances to host a custom server build. You can complete the configuration by using update-fleet.

aws gamelift create-fleet \
    --name MegaFrogRaceServer.NA.v2 \
    --description 'Hosts for v2 North America' \
    --build-id build-1111aaaa-22bb-33cc-44dd-5555eeee66ff \
    --certificate-configuration 'CertificateType=GENERATED' \
    --ec2-instance-type c4.large \
    --fleet-type ON_DEMAND \
    --runtime-configuration 'ServerProcesses=[{LaunchPath=/local/game/release-na/MegaFrogRace_Server.exe,ConcurrentExecutions=1}]'

Output:

{
    "FleetAttributes": {
        "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
        "CertificateConfiguration": {
            "CertificateType": "GENERATED"
        },
        "CreationTime": 1496365885.44,
        "Description": "Hosts for v2 North America",
        "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
        "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
        "FleetType": "ON_DEMAND",
        "InstanceType": "c4.large",
        "MetricGroups": ["default"],
        "Name": "MegaFrogRace.NA.v2",
        "NewGameSessionProtectionPolicy": "NoProtection",
        "OperatingSystem": "AMAZON_LINUX",
        "ServerLaunchPath": "/local/game/release-na/MegaFrogRace_Server.exe",
        "Status": "NEW"
    }
}

Example 2: To create a basic Windows fleet

The following create-fleet example creates a minimally configured fleet of spot Windows instances to host a custom server build. You can complete the configuration by using update-fleet.

aws gamelift create-fleet \
    --name MegaFrogRace.NA.v2 \
    --description 'Hosts for v2 North America' \
    --build-id build-2222aaaa-33bb-44cc-55dd-6666eeee77ff  \
    --certificate-configuration 'CertificateType=GENERATED' \
    --ec2-instance-type c4.large \
    --fleet-type SPOT \
    --runtime-configuration 'ServerProcesses=[{LaunchPath=C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,ConcurrentExecutions=1}]'

Output:

{
    "FleetAttributes": {
        "BuildId": "build-2222aaaa-33bb-44cc-55dd-6666eeee77ff",
        "CertificateConfiguration": {
            "CertificateType": "GENERATED"
        },
        "CreationTime": 1496365885.44,
        "Description": "Hosts for v2 North America",
        "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
        "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
        "FleetType": "SPOT",
        "InstanceType": "c4.large",
        "MetricGroups": ["default"],
        "Name": "MegaFrogRace.NA.v2",
        "NewGameSessionProtectionPolicy": "NoProtection",
        "OperatingSystem": "WINDOWS_2012",
        "ServerLaunchPath": "C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe",
        "Status": "NEW"
    }
}

Example 3: To create a fully configured fleet

The following create-fleet example creates a fleet of Spot Windows instances for a custom server build, with most commonly used configuration settings provided.

aws gamelift create-fleet \
    --name MegaFrogRace.NA.v2 \
    --description 'Hosts for v2 North America' \
    --build-id build-2222aaaa-33bb-44cc-55dd-6666eeee77ff \
    --certificate-configuration 'CertificateType=GENERATED' \
    --ec2-instance-type c4.large \
    --ec2-inbound-permissions 'FromPort=33435,ToPort=33435,IpRange=10.24.34.0/23,Protocol=UDP' \
    --fleet-type SPOT \
    --new-game-session-protection-policy FullProtection \
    --runtime-configuration file://runtime-config.json \
    --metric-groups default \
    --instance-role-arn 'arn:aws:iam::444455556666:role/GameLiftS3Access'

Contents of runtime-config.json:

GameSessionActivationTimeoutSeconds=300,
 MaxConcurrentGameSessionActivations=2,
 ServerProcesses=[
   {LaunchPath=C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,Parameters=-debug,ConcurrentExecutions=1},
   {LaunchPath=C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,ConcurrentExecutions=1}]

Output:

{
    "FleetAttributes": {
        "InstanceRoleArn": "arn:aws:iam::444455556666:role/GameLiftS3Access",
        "Status": "NEW",
        "InstanceType": "c4.large",
        "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
        "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
        "Description": "Hosts for v2 North America",
        "FleetType": "SPOT",
        "OperatingSystem": "WINDOWS_2012",
        "Name": "MegaFrogRace.NA.v2",
        "CreationTime": 1569309011.11,
        "MetricGroups": [
            "default"
        ],
        "BuildId": "build-2222aaaa-33bb-44cc-55dd-6666eeee77ff",
        "ServerLaunchParameters": "abc",
        "ServerLaunchPath": "C:\\game\\Bin64.Release.Dedicated\\MegaFrogRace_Server.exe",
        "NewGameSessionProtectionPolicy": "FullProtection",
        "CertificateConfiguration": {
            "CertificateType": "GENERATED"
        }
    }
}

Example 4: To create a Realtime Servers fleet

The following create-fleet example creates a fleet of Spot instances with a Realtime configuration script that has been uploaded to Amazon GameLift. All Realtime servers are deployed onto Linux machines. For the purposes of this example, assume that the uploaded Realtime script includes multiple script files, with the Init() function located in the script file called MainScript.js. As shown, this file is identified as the launch script in the runtime configuration.

aws gamelift create-fleet \
    --name MegaFrogRace.NA.realtime \
    --description 'Mega Frog Race Realtime fleet' \
    --script-id script-1111aaaa-22bb-33cc-44dd-5555eeee66ff \
    --ec2-instance-type c4.large \
    --fleet-type SPOT \
    --certificate-configuration 'CertificateType=GENERATED' --runtime-configuration 'ServerProcesses=[{LaunchPath=/local/game/MainScript.js,Parameters=+map Winter444,ConcurrentExecutions=5}]'

Output:

{
    "FleetAttributes": {
        "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
        "Status": "NEW",
        "CreationTime": 1569310745.212,
        "InstanceType": "c4.large",
        "NewGameSessionProtectionPolicy": "NoProtection",
        "CertificateConfiguration": {
            "CertificateType": "GENERATED"
        },
        "Name": "MegaFrogRace.NA.realtime",
        "ScriptId": "script-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
        "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
        "FleetType": "SPOT",
        "MetricGroups": [
            "default"
        ],
        "Description": "Mega Frog Race Realtime fleet",
        "OperatingSystem": "AMAZON_LINUX"
    }
}

Output

FleetAttributes -> (structure)

Properties for the newly created fleet.

FleetId -> (string)

A unique identifier for a fleet.

FleetArn -> (string)

The Amazon Resource Name (ARN ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.

FleetType -> (string)

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

InstanceType -> (string)

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

Description -> (string)

Human-readable description of the fleet.

Name -> (string)

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

CreationTime -> (timestamp)

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example “1469498468.057”).

TerminationTime -> (timestamp)

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example “1469498468.057”).

Status -> (string)

Current status of the fleet.

Possible fleet statuses include the following:

  • NEW – A new fleet has been defined and desired instances is set to 1.

  • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

  • ACTIVE – Hosts can now accept game sessions.

  • ERROR – An error occurred when downloading, validating, building, or activating the fleet.

  • DELETING – Hosts are responding to a delete fleet request.

  • TERMINATED – The fleet no longer exists.

BuildId -> (string)

A unique identifier for a build.

BuildArn -> (string)

The Amazon Resource Name (ARN ) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

ScriptId -> (string)

A unique identifier for a Realtime script.

ScriptArn -> (string)

The Amazon Resource Name (ARN ) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

ServerLaunchPath -> (string)

Path to a game server executable in the fleet’s build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet’s RuntimeConfiguration .

ServerLaunchParameters -> (string)

Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet’s RuntimeConfiguration .

LogPaths -> (list)

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide . If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

(string)

NewGameSessionProtectionPolicy -> (string)

The type of game session protection to set for all new instances started in the fleet.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

OperatingSystem -> (string)

Operating system of the fleet’s computing resources. A fleet’s operating system depends on the OS specified for the build that is deployed on this fleet.

ResourceCreationLimitPolicy -> (structure)

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

NewGameSessionsPerCreator -> (integer)

The maximum number of game sessions that an individual can create during the policy period.

PolicyPeriodInMinutes -> (integer)

The time span used in evaluating the resource creation limit policy.

MetricGroups -> (list)

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

(string)

StoppedActions -> (list)

List of fleet activity that have been suspended using StopFleetActions . This includes auto-scaling.

(string)

InstanceRoleArn -> (string)

A unique identifier for an AWS 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 from 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 .

CertificateConfiguration -> (structure)

Indicates whether a TLS/SSL certificate was generated for the fleet.

CertificateType -> (string)

Indicates whether a TLS/SSL certificate was generated for a fleet.