aws_sdk_gamelift/client/
register_game_server.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`RegisterGameServer`](crate::operation::register_game_server::builders::RegisterGameServerFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`game_server_group_name(impl Into<String>)`](crate::operation::register_game_server::builders::RegisterGameServerFluentBuilder::game_server_group_name) / [`set_game_server_group_name(Option<String>)`](crate::operation::register_game_server::builders::RegisterGameServerFluentBuilder::set_game_server_group_name):<br>required: **true**<br><p>A unique identifier for the game server group where the game server is running.</p><br>
7    ///   - [`game_server_id(impl Into<String>)`](crate::operation::register_game_server::builders::RegisterGameServerFluentBuilder::game_server_id) / [`set_game_server_id(Option<String>)`](crate::operation::register_game_server::builders::RegisterGameServerFluentBuilder::set_game_server_id):<br>required: **true**<br><p>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.</p><br>
8    ///   - [`instance_id(impl Into<String>)`](crate::operation::register_game_server::builders::RegisterGameServerFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::register_game_server::builders::RegisterGameServerFluentBuilder::set_instance_id):<br>required: **true**<br><p>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: <code>i-1234567890abcdef0</code>.</p><br>
9    ///   - [`connection_info(impl Into<String>)`](crate::operation::register_game_server::builders::RegisterGameServerFluentBuilder::connection_info) / [`set_connection_info(Option<String>)`](crate::operation::register_game_server::builders::RegisterGameServerFluentBuilder::set_connection_info):<br>required: **false**<br><p>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.</p><br>
10    ///   - [`game_server_data(impl Into<String>)`](crate::operation::register_game_server::builders::RegisterGameServerFluentBuilder::game_server_data) / [`set_game_server_data(Option<String>)`](crate::operation::register_game_server::builders::RegisterGameServerFluentBuilder::set_game_server_data):<br>required: **false**<br><p>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.</p><br>
11    /// - On success, responds with [`RegisterGameServerOutput`](crate::operation::register_game_server::RegisterGameServerOutput) with field(s):
12    ///   - [`game_server(Option<GameServer>)`](crate::operation::register_game_server::RegisterGameServerOutput::game_server): <p>Object that describes the newly registered game server.</p>
13    /// - On failure, responds with [`SdkError<RegisterGameServerError>`](crate::operation::register_game_server::RegisterGameServerError)
14    pub fn register_game_server(&self) -> crate::operation::register_game_server::builders::RegisterGameServerFluentBuilder {
15        crate::operation::register_game_server::builders::RegisterGameServerFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_gamelift/client/register_game_server.rs

aws_sdk_gamelift/client/
register_game_server.rs
