Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . gamelift ]

update-fleet-capacity

Description

Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call describe-ec2-instance-limits to get the maximum capacity based on the fleet's EC2 instance type.

If you're using autoscaling (see put-scaling-policy ), you may want to specify a minimum and/or maximum capacity. If you don't provide these, autoscaling can set capacity anywhere between zero and the service limits .

To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling describe-fleet-capacity . If the desired instance count is higher than the instance type's limit, the "Limit Exceeded" exception occurs.

Fleet-related operations include:

  • create-fleet
  • list-fleets
  • Describe fleets:
    • describe-fleet-attributes
    • describe-fleet-port-settings
    • describe-fleet-utilization
    • describe-runtime-configuration
    • describe-fleet-events
  • Update fleets:
    • update-fleet-attributes
    • update-fleet-capacity
    • update-fleet-port-settings
    • update-runtime-configuration
  • Manage fleet capacity:
    • describe-fleet-capacity
    • update-fleet-capacity
    • put-scaling-policy (automatic scaling)
    • describe-scaling-policies (automatic scaling)
    • delete-scaling-policy (automatic scaling)
    • describe-ec2-instance-limits
  • delete-fleet

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-fleet-capacity
--fleet-id <value>
[--desired-instances <value>]
[--min-size <value>]
[--max-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--fleet-id (string)

Unique identifier for a fleet to update capacity for.

--desired-instances (integer)

Number of EC2 instances you want this fleet to host.

--min-size (integer)

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

--max-size (integer)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

FleetId -> (string)

Unique identifier for a fleet that was updated.