Struct aws_sdk_gamelift::client::fluent_builders::UpdateFleetCapacity

pub struct UpdateFleetCapacity { /* private fields */ }

Fluent builder constructing a request to UpdateFleetCapacity.

Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Fleet capacity determines the number of game sessions and players that can be hosted based on the fleet configuration. Use this operation to set the following fleet capacity properties:

• Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's capacity to a value outside of this range, whether the capacity is changed manually or through automatic scaling.

• Desired capacity: Manually set the number of Amazon EC2 instances to be maintained in a fleet location. Before changing a fleet's desired capacity, you may want to call DescribeEC2InstanceLimits to get the maximum capacity of the fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to adjust capacity based on player demand.

This operation can be used in the following ways:

• To update capacity for a fleet's home Region, or if the fleet has no remote locations, omit the Location parameter. The fleet must be in ACTIVE status.

• To update capacity for a fleet's remote location, include the Location parameter set to the location to be updated. The location must be in ACTIVE status.

If successful, capacity settings are updated immediately. In response a change in desired capacity, GameLift initiates steps to start new instances or terminate existing instances in the requested fleet location. This continues until the location's active instance count matches the new desired instance count. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count is higher than the instance type's limit, the LimitExceeded exception occurs.

Learn more

Scaling fleet capacity

Related actions

CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task

Implementations

impl UpdateFleetCapacity

pub async fn send(
    self
) -> Result<UpdateFleetCapacityOutput, SdkError<UpdateFleetCapacityError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn fleet_id(self, input: impl Into<String>) -> Self

A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value.

pub fn set_fleet_id(self, input: Option<String>) -> Self

A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value.

pub fn desired_instances(self, input: i32) -> Self

The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.

pub fn set_desired_instances(self, input: Option<i32>) -> Self

The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.

pub fn min_size(self, input: i32) -> Self

The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.

pub fn set_min_size(self, input: Option<i32>) -> Self

The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.

pub fn max_size(self, input: i32) -> Self

The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.

pub fn set_max_size(self, input: Option<i32>) -> Self

The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.

pub fn location(self, input: impl Into<String>) -> Self

The name of a remote location to update fleet capacity settings for, in the form of an Amazon Web Services Region code such as us-west-2.

pub fn set_location(self, input: Option<String>) -> Self

The name of a remote location to update fleet capacity settings for, in the form of an Amazon Web Services Region code such as us-west-2.

Trait Implementations

impl Clone for UpdateFleetCapacity

fn clone(&self) -> UpdateFleetCapacity

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateFleetCapacity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.