Struct aws_sdk_gamelift::client::fluent_builders::RegisterGameServer

pub struct RegisterGameServer { /* private fields */ }

Fluent builder constructing a request to RegisterGameServer.

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

Creates a new game server resource and notifies GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session.

To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data. When a game client or service requests a game server by calling ClaimGameServer, this information is returned in the response.

Once a game server is successfully registered, it is put in status AVAILABLE. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity.

Learn more

GameLift FleetIQ Guide

Related actions

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

Implementations

impl RegisterGameServer

pub async fn send(
    self
) -> Result<RegisterGameServerOutput, SdkError<RegisterGameServerError>>

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 register. Game server IDs are developer-defined and must be unique across all game server groups in your Amazon Web Services account.

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

A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your Amazon Web Services account.

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

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

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

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

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

Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.

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

Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.

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.

Trait Implementations

impl Clone for RegisterGameServer

fn clone(&self) -> RegisterGameServer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegisterGameServer

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

Formats the value using the given formatter.