Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Learn more
Synopsis
- data StopFleetActions = StopFleetActions' {}
- newStopFleetActions :: Text -> NonEmpty FleetAction -> StopFleetActions
- stopFleetActions_location :: Lens' StopFleetActions (Maybe Text)
- stopFleetActions_fleetId :: Lens' StopFleetActions Text
- stopFleetActions_actions :: Lens' StopFleetActions (NonEmpty FleetAction)
- data StopFleetActionsResponse = StopFleetActionsResponse' {}
- newStopFleetActionsResponse :: Int -> StopFleetActionsResponse
- stopFleetActionsResponse_fleetArn :: Lens' StopFleetActionsResponse (Maybe Text)
- stopFleetActionsResponse_fleetId :: Lens' StopFleetActionsResponse (Maybe Text)
- stopFleetActionsResponse_httpStatus :: Lens' StopFleetActionsResponse Int
Creating a Request
data StopFleetActions Source #
See: newStopFleetActions
smart constructor.
StopFleetActions' | |
|
Instances
Create a value of StopFleetActions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopFleetActions
, stopFleetActions_location
- 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
.
StopFleetActions
, stopFleetActions_fleetId
- A unique identifier for the fleet to stop actions on. You can use either
the fleet ID or ARN value.
$sel:actions:StopFleetActions'
, stopFleetActions_actions
- List of actions to suspend on the fleet.
Request Lenses
stopFleetActions_location :: Lens' StopFleetActions (Maybe Text) Source #
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
.
stopFleetActions_fleetId :: Lens' StopFleetActions Text Source #
A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.
stopFleetActions_actions :: Lens' StopFleetActions (NonEmpty FleetAction) Source #
List of actions to suspend on the fleet.
Destructuring the Response
data StopFleetActionsResponse Source #
See: newStopFleetActionsResponse
smart constructor.
StopFleetActionsResponse' | |
|
Instances
newStopFleetActionsResponse Source #
Create a value of StopFleetActionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopFleetActionsResponse
, stopFleetActionsResponse_fleetArn
- The Amazon Resource Name
(ARN)
that is assigned to a GameLift fleet resource and uniquely identifies
it. ARNs are unique across all Regions. Format is
arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912
.
StopFleetActions
, stopFleetActionsResponse_fleetId
- A unique identifier for the fleet to stop actions on.
$sel:httpStatus:StopFleetActionsResponse'
, stopFleetActionsResponse_httpStatus
- The response's http status code.
Response Lenses
stopFleetActionsResponse_fleetArn :: Lens' StopFleetActionsResponse (Maybe Text) Source #
The Amazon Resource Name
(ARN)
that is assigned to a GameLift fleet resource and uniquely identifies
it. ARNs are unique across all Regions. Format is
arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912
.
stopFleetActionsResponse_fleetId :: Lens' StopFleetActionsResponse (Maybe Text) Source #
A unique identifier for the fleet to stop actions on.
stopFleetActionsResponse_httpStatus :: Lens' StopFleetActionsResponse Int Source #
The response's http status code.