Struct aws_sdk_gamelift::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder

pub struct UpdateFleetCapacityFluentBuilder { /* private fields */ }

Fluent builder constructing a request to UpdateFleetCapacity.

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

Updates capacity settings for a managed EC2 fleet or container fleet. For these fleets, you adjust capacity by changing the number of instances in the fleet. Fleet capacity determines the number of game sessions and players that the fleet can host based on its configuration. For fleets with multiple locations, use this operation to manage capacity settings in each location individually.

Use this operation to set these fleet capacity properties:

• Minimum/maximum size: Set hard limits on the number of Amazon EC2 instances allowed. If Amazon GameLift receives a request--either through manual update or automatic scaling--it won't change the capacity to a value outside of this range.

• Desired capacity: As an alternative to automatic scaling, manually set the number of Amazon EC2 instances to be maintained. Before changing a fleet's desired capacity, check the maximum capacity of the fleet's Amazon EC2 instance type by calling DescribeEC2InstanceLimits.

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, set the Location parameter to the location to update. The location must be in ACTIVE status.

If successful, Amazon GameLift updates the capacity settings and returns the identifiers for the updated fleet and/or location. If a requested change to desired capacity exceeds the instance type's limit, the LimitExceeded exception occurs.

Updates often prompt an immediate change in fleet capacity, such as when current capacity is different than the new desired capacity or outside the new limits. In this scenario, Amazon GameLift automatically initiates steps to add or remove instances in the fleet location. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity.

Learn more

Scaling fleet capacity

Implementations

impl UpdateFleetCapacityFluentBuilder

pub fn as_input(&self) -> &UpdateFleetCapacityInputBuilder

Access the UpdateFleetCapacity as a reference.

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

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 customize( self ) -> CustomizableOperation<UpdateFleetCapacityOutput, UpdateFleetCapacityError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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 get_fleet_id(&self) -> &Option<String>

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. Changes in desired instance value can take up to 1 minute to be reflected when viewing the fleet's capacity settings.

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. Changes in desired instance value can take up to 1 minute to be reflected when viewing the fleet's capacity settings.

pub fn get_desired_instances(&self) -> &Option<i32>

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. Changes in desired instance value can take up to 1 minute to be reflected when viewing the fleet's capacity settings.

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 get_min_size(&self) -> &Option<i32>

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 get_max_size(&self) -> &Option<i32>

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.

pub fn get_location(&self) -> &Option<String>

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 UpdateFleetCapacityFluentBuilder

fn clone(&self) -> UpdateFleetCapacityFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateFleetCapacityFluentBuilder

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

Formats the value using the given formatter.