Network.AWS.GameLift.UpdateFleetCapacity

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

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

To update fleet capacity, specify the fleet ID and the desired number of instances. 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 DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the "Limit Exceeded" exception will occur.

Creating a Request

updateFleetCapacity

Arguments

:: Text

ufcFleetId

-> UpdateFleetCapacity

Creates a value of UpdateFleetCapacity with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ufcMaxSize
• ufcMinSize
• ufcDesiredInstances
• ufcFleetId

data UpdateFleetCapacity

Represents the input for a request action.

See: updateFleetCapacity smart constructor.

Instances

Eq UpdateFleetCapacity

Data UpdateFleetCapacity

Read UpdateFleetCapacity

Show UpdateFleetCapacity

Generic UpdateFleetCapacity

ToJSON UpdateFleetCapacity

Hashable UpdateFleetCapacity

AWSRequest UpdateFleetCapacity

ToPath UpdateFleetCapacity

ToHeaders UpdateFleetCapacity

ToQuery UpdateFleetCapacity

type Rep UpdateFleetCapacity

type Rs UpdateFleetCapacity = UpdateFleetCapacityResponse

Request Lenses

ufcMaxSize :: Lens' UpdateFleetCapacity (Maybe Natural)

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

ufcMinSize :: Lens' UpdateFleetCapacity (Maybe Natural)

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

ufcDesiredInstances :: Lens' UpdateFleetCapacity (Maybe Natural)

Number of EC2 instances you want this fleet to host.

ufcFleetId :: Lens' UpdateFleetCapacity Text

Unique identifier for the fleet you want to update capacity for.

Destructuring the Response

updateFleetCapacityResponse

Arguments

:: Int

ufcrsResponseStatus

-> UpdateFleetCapacityResponse

Creates a value of UpdateFleetCapacityResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ufcrsFleetId
• ufcrsResponseStatus

data UpdateFleetCapacityResponse

Represents the returned data in response to a request action.

See: updateFleetCapacityResponse smart constructor.

Instances

Eq UpdateFleetCapacityResponse

Data UpdateFleetCapacityResponse

Read UpdateFleetCapacityResponse

Show UpdateFleetCapacityResponse

Generic UpdateFleetCapacityResponse

type Rep UpdateFleetCapacityResponse

Response Lenses

ufcrsFleetId :: Lens' UpdateFleetCapacityResponse (Maybe Text)

Unique identifier for the updated fleet.

ufcrsResponseStatus :: Lens' UpdateFleetCapacityResponse Int

The response status code.