Struct aws_sdk_gamelift::client::fluent_builders::SuspendGameServerGroup

pub struct SuspendGameServerGroup<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to SuspendGameServerGroup.

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

GameLift FleetIQ Guide

Related actions

CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task

Implementations

impl<C, M, R> SuspendGameServerGroup<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<SuspendGameServerGroupOutput, SdkError<SuspendGameServerGroupError>> where
    R::Policy: SmithyRetryPolicy<SuspendGameServerGroupInputOperationOutputAlias, SuspendGameServerGroupOutput, SuspendGameServerGroupError, SuspendGameServerGroupInputOperationRetryAlias>, 

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 game_server_group_name(self, inp: impl Into<String>) -> Self

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

pub fn set_game_server_group_name(self, input: Option<String>) -> Self

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

pub fn suspend_actions(self, inp: impl Into<GameServerGroupAction>) -> Self

Appends an item to SuspendActions.

To override the contents of this collection use set_suspend_actions.

The activity to suspend for this game server group.

pub fn set_suspend_actions(
    self,
    input: Option<Vec<GameServerGroupAction>>
) -> Self

The activity to suspend for this game server group.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for SuspendGameServerGroup<C, M, R>

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

Formats the value using the given formatter.