pub struct DeregisterGameServer { /* private fields */ }Expand description
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
Related actions
RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task
Implementations
sourceimpl DeregisterGameServer
impl DeregisterGameServer
sourcepub async fn send(
self
) -> Result<DeregisterGameServerOutput, SdkError<DeregisterGameServerError>>
pub async fn send(
self
) -> Result<DeregisterGameServerOutput, SdkError<DeregisterGameServerError>>
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.
sourcepub fn game_server_group_name(self, input: impl Into<String>) -> Self
pub fn game_server_group_name(self, input: 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.
sourcepub fn set_game_server_group_name(self, input: Option<String>) -> Self
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.
sourcepub fn game_server_id(self, input: impl Into<String>) -> Self
pub fn game_server_id(self, input: impl Into<String>) -> Self
A custom string that uniquely identifies the game server to deregister.
sourcepub fn set_game_server_id(self, input: Option<String>) -> Self
pub fn set_game_server_id(self, input: Option<String>) -> Self
A custom string that uniquely identifies the game server to deregister.
Trait Implementations
sourceimpl Clone for DeregisterGameServer
impl Clone for DeregisterGameServer
sourcefn clone(&self) -> DeregisterGameServer
fn clone(&self) -> DeregisterGameServer
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
Auto Trait Implementations
impl !RefUnwindSafe for DeregisterGameServer
impl Send for DeregisterGameServer
impl Sync for DeregisterGameServer
impl Unpin for DeregisterGameServer
impl !UnwindSafe for DeregisterGameServer
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more