Struct aws_sdk_gamelift::client::fluent_builders::UpdateGameServer

pub struct UpdateGameServer { /* private fields */ }

Fluent builder constructing a request to UpdateGameServer.

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

Updates information about a registered game server to help GameLift FleetIQ to track game server availability. This operation is called by a game server process that is running on an instance in a game server group.

Use this operation to update the following types of game server information. You can make all three types of updates in the same request:

• To update the game server's utilization status, identify the game server and game server group and specify the current utilization status. Use this status to identify when game servers are currently hosting games and when they are available to be claimed.

• To report health status, identify the game server and game server group and set health check to HEALTHY. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds.

• To change game server metadata, provide updated game server data.

Once a game server is successfully updated, the relevant statuses and timestamps are updated.

Learn more

GameLift FleetIQ Guide

Related actions

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

Implementations

impl UpdateGameServer

pub async fn send(
    self
) -> Result<UpdateGameServerOutput, SdkError<UpdateGameServerError>>

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 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, input: impl Into<String>) -> Self

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

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

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

pub fn game_server_data(self, input: impl Into<String>) -> Self

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

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

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

pub fn utilization_status(self, input: GameServerUtilizationStatus) -> Self

Indicates whether the game server is available or is currently hosting gameplay.

pub fn set_utilization_status(
    self,
    input: Option<GameServerUtilizationStatus>
) -> Self

Indicates whether the game server is available or is currently hosting gameplay.

pub fn health_check(self, input: GameServerHealthCheck) -> Self

Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.

pub fn set_health_check(self, input: Option<GameServerHealthCheck>) -> Self

Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.

Trait Implementations

impl Clone for UpdateGameServer

fn clone(&self) -> UpdateGameServer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateGameServer

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

Formats the value using the given formatter.