Container for the parameters to the StopFleetActions operation. 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, Amazon GameLift Servers no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity. To restart fleet actions again, call StartFleetActions.
Learn more
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.StopFleetActionsRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class StopFleetActionsRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The StopFleetActionsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
StopFleetActionsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Actions | System.Collections.Generic.List<System.String> |
Gets and sets the property Actions. List of actions to suspend on the fleet. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. |
|
|
FleetId | System.String |
Gets and sets the property FleetId. A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value. |
|
|
Location | System.String |
Gets and sets the property Location.
The fleet location to stop fleet actions for. Specify a location in the form of an
Amazon Web Services Region code, such as |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer