Struct aws_sdk_gamelift::client::fluent_builders::StopFleetActions

pub struct StopFleetActions { /* private fields */ }

Fluent builder constructing a request to StopFleetActions.

Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location.

Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations.

This operation can be used in the following ways:

• To stop actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to suspend.

• To stop actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to suspend.

If successful, GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity. You can view a fleet's stopped actions using DescribeFleetAttributes or DescribeFleetLocationAttributes. Suspended activity can be restarted using StartFleetActions.

Learn more

Setting up GameLift Fleets

Related actions

CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task

Implementations

impl StopFleetActions

pub async fn send(
    self
) -> Result<StopFleetActionsOutput, SdkError<StopFleetActionsError>>

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 stop actions on. 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 stop actions on. You can use either the fleet ID or ARN value.

pub fn actions(self, input: FleetAction) -> Self

Appends an item to Actions.

To override the contents of this collection use set_actions.

List of actions to suspend on the fleet.

pub fn set_actions(self, input: Option<Vec<FleetAction>>) -> Self

List of actions to suspend on the fleet.

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

The fleet location to stop fleet actions for. Specify a location 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 fleet location to stop fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.

Trait Implementations

impl Clone for StopFleetActions

fn clone(&self) -> StopFleetActions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StopFleetActions

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

Formats the value using the given formatter.