Struct aws_sdk_gamelift::operation::claim_game_server::builders::ClaimGameServerFluentBuilder

pub struct ClaimGameServerFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ClaimGameServer.

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

Locates an available game server and temporarily reserves it to host gameplay and players. This operation is called from a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, Amazon GameLift FleetIQ locates an available game server, places it in CLAIMED status for 60 seconds, and returns connection information that players can use to connect to the game server.

To claim a game server, identify a game server group. You can also specify a game server ID, although this approach bypasses Amazon GameLift FleetIQ placement optimization. Optionally, include game data to pass to the game server at the start of a game session, such as a game map or player information. Add filter options to further restrict how a game server is chosen, such as only allowing game servers on ACTIVE instances to be claimed.

When a game server is successfully claimed, connection information is returned. A claimed game server's utilization status remains AVAILABLE while the claim status is set to CLAIMED for up to 60 seconds. This time period gives the game server time to update its status to UTILIZED after players join. If the game server's status is not updated within 60 seconds, the game server reverts to unclaimed status and is available to be claimed by another request. The claim time period is a fixed value and is not configurable.

If you try to claim a specific game server, this request will fail in the following cases:

• If the game server utilization status is UTILIZED.

• If the game server claim status is CLAIMED.

• If the game server is running on an instance in DRAINING status and the provided filter option does not allow placing on DRAINING instances.

Learn more

Amazon GameLift FleetIQ Guide

Implementations

impl ClaimGameServerFluentBuilder

pub fn as_input(&self) -> &ClaimGameServerInputBuilder

Access the ClaimGameServer as a reference.

pub async fn send( self ) -> Result<ClaimGameServerOutput, SdkError<ClaimGameServerError, HttpResponse>>

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 customize( self ) -> CustomizableOperation<ClaimGameServerOutput, ClaimGameServerError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim.

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. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim.

pub fn get_game_server_group_name(&self) -> &Option<String>

A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim.

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

A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon GameLift FleetIQ searches for an available game server in the specified game server group.

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

A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon GameLift FleetIQ searches for an available game server in the specified game server group.

pub fn get_game_server_id(&self) -> &Option<String>

A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon GameLift FleetIQ searches for an available game server in the specified game server group.

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.

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.

pub fn get_game_server_data(&self) -> &Option<String>

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.

pub fn filter_option(self, input: ClaimFilterOption) -> Self

Object that restricts how a claimed game server is chosen.

pub fn set_filter_option(self, input: Option<ClaimFilterOption>) -> Self

Object that restricts how a claimed game server is chosen.

pub fn get_filter_option(&self) -> &Option<ClaimFilterOption>

Object that restricts how a claimed game server is chosen.

Trait Implementations

impl Clone for ClaimGameServerFluentBuilder

fn clone(&self) -> ClaimGameServerFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClaimGameServerFluentBuilder

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

Formats the value using the given formatter.