| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.GameLift.SuspendGameServerGroup
Description
__This operation is used with the GameLift FleetIQ solution and game server groups.__
Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity:
- Instance type replacement - This activity evaluates the current game hosting viability of all Spot instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot Instance types, which have a higher chance of game server interruptions. It then balances capacity across the remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity scaling activities continue to be active.
To suspend activity, specify a game server group ARN and the type of
activity to be suspended. If successful, a GameServerGroup object is
returned showing that the activity is listed in SuspendedActions.
Learn more
Related actions
CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task
Synopsis
- data SuspendGameServerGroup = SuspendGameServerGroup' {}
- newSuspendGameServerGroup :: Text -> NonEmpty GameServerGroupAction -> SuspendGameServerGroup
- suspendGameServerGroup_gameServerGroupName :: Lens' SuspendGameServerGroup Text
- suspendGameServerGroup_suspendActions :: Lens' SuspendGameServerGroup (NonEmpty GameServerGroupAction)
- data SuspendGameServerGroupResponse = SuspendGameServerGroupResponse' {}
- newSuspendGameServerGroupResponse :: Int -> SuspendGameServerGroupResponse
- suspendGameServerGroupResponse_gameServerGroup :: Lens' SuspendGameServerGroupResponse (Maybe GameServerGroup)
- suspendGameServerGroupResponse_httpStatus :: Lens' SuspendGameServerGroupResponse Int
Creating a Request
data SuspendGameServerGroup Source #
See: newSuspendGameServerGroup smart constructor.
Constructors
| SuspendGameServerGroup' | |
Fields
| |
Instances
newSuspendGameServerGroup Source #
Arguments
| :: Text | |
| -> NonEmpty GameServerGroupAction | |
| -> SuspendGameServerGroup |
Create a value of SuspendGameServerGroup 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:
$sel:gameServerGroupName:SuspendGameServerGroup', suspendGameServerGroup_gameServerGroupName - A unique identifier for the game server group. Use either the
GameServerGroup name or ARN value.
$sel:suspendActions:SuspendGameServerGroup', suspendGameServerGroup_suspendActions - The activity to suspend for this game server group.
Request Lenses
suspendGameServerGroup_gameServerGroupName :: Lens' SuspendGameServerGroup Text Source #
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
suspendGameServerGroup_suspendActions :: Lens' SuspendGameServerGroup (NonEmpty GameServerGroupAction) Source #
The activity to suspend for this game server group.
Destructuring the Response
data SuspendGameServerGroupResponse Source #
See: newSuspendGameServerGroupResponse smart constructor.
Constructors
| SuspendGameServerGroupResponse' | |
Fields
| |
Instances
newSuspendGameServerGroupResponse Source #
Create a value of SuspendGameServerGroupResponse 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:
$sel:gameServerGroup:SuspendGameServerGroupResponse', suspendGameServerGroupResponse_gameServerGroup - An object that describes the game server group resource, with the
SuspendedActions property updated to reflect the suspended activity.
$sel:httpStatus:SuspendGameServerGroupResponse', suspendGameServerGroupResponse_httpStatus - The response's http status code.
Response Lenses
suspendGameServerGroupResponse_gameServerGroup :: Lens' SuspendGameServerGroupResponse (Maybe GameServerGroup) Source #
An object that describes the game server group resource, with the
SuspendedActions property updated to reflect the suspended activity.
suspendGameServerGroupResponse_httpStatus :: Lens' SuspendGameServerGroupResponse Int Source #
The response's http status code.