Struct aws_sdk_gamelift::client::fluent_builders::DeleteGameServerGroup

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

Fluent builder constructing a request to DeleteGameServerGroup.

This operation is used with the GameLift FleetIQ solution and game server groups.

Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:

• The game server group

• The corresponding Auto Scaling group

• All game servers that are currently running in the group

To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in ACTIVE or ERROR status.

If the delete request is successful, a series of operations are kicked off. The game server group status is changed to DELETE_SCHEDULED, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed in ERROR status.

GameLift FleetIQ emits delete events to Amazon CloudWatch.

Learn more

GameLift FleetIQ Guide

Related actions

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

Implementations

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

pub async fn send(
    self
) -> Result<DeleteGameServerGroupOutput, SdkError<DeleteGameServerGroupError>> where
    R::Policy: SmithyRetryPolicy<DeleteGameServerGroupInputOperationOutputAlias, DeleteGameServerGroupOutput, DeleteGameServerGroupError, DeleteGameServerGroupInputOperationRetryAlias>, 

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, input: 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 delete_option(self, input: GameServerGroupDeleteOption) -> Self

The type of delete to perform. Options include the following:

• SAFE_DELETE – (default) Terminates the game server group and EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status.

• FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the EC2 Auto Scaling group.

• RETAIN – Does a safe delete of the game server group but retains the EC2 Auto Scaling group as is.

pub fn set_delete_option(
    self,
    input: Option<GameServerGroupDeleteOption>
) -> Self

The type of delete to perform. Options include the following:

• SAFE_DELETE – (default) Terminates the game server group and EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status.

• FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the EC2 Auto Scaling group.

• RETAIN – Does a safe delete of the game server group but retains the EC2 Auto Scaling group as is.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for DeleteGameServerGroup<C, M, R>

fn clone(&self) -> DeleteGameServerGroup<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.