Struct aws_sdk_gamelift::client::fluent_builders::DeregisterGameServer

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

Fluent builder constructing a request to DeregisterGameServer.

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

Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.

To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.

Learn more

GameLift FleetIQ Guide

Related actions

RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task

Implementations

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

pub async fn send(
    self
) -> Result<DeregisterGameServerOutput, SdkError<DeregisterGameServerError>> where
    R::Policy: SmithyRetryPolicy<DeregisterGameServerInputOperationOutputAlias, DeregisterGameServerOutput, DeregisterGameServerError, DeregisterGameServerInputOperationRetryAlias>, 

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 where the game server is running. 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 where the game server is running. Use either the GameServerGroup name or ARN value.

pub fn game_server_id(self, inp: impl Into<String>) -> Self

A custom string that uniquely identifies the game server to deregister.

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

A custom string that uniquely identifies the game server to deregister.

Trait Implementations

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

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

Formats the value using the given formatter.