aws_sdk_gamelift/operation/suspend_game_server_group/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::suspend_game_server_group::_suspend_game_server_group_output::SuspendGameServerGroupOutputBuilder;
3
4pub use crate::operation::suspend_game_server_group::_suspend_game_server_group_input::SuspendGameServerGroupInputBuilder;
5
6impl crate::operation::suspend_game_server_group::builders::SuspendGameServerGroupInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::suspend_game_server_group::SuspendGameServerGroupOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::suspend_game_server_group::SuspendGameServerGroupError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.suspend_game_server_group();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `SuspendGameServerGroup`.
24///
25/// <p><b>This API works with the following fleet types:</b> EC2 (FleetIQ)</p>
26/// <p>Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling <a href="gamelift/latest/apireference/API_ResumeGameServerGroup.html">ResumeGameServerGroup</a>. You can suspend the following activity:</p>
27/// <ul>
28/// <li>
29/// <p><b>Instance type replacement</b> - This activity evaluates the current game hosting viability of all Spot instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot Instance types, which have a higher chance of game server interruptions. It then balances capacity across the remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity scaling activities continue to be active.</p></li>
30/// </ul>
31/// <p>To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a <code>GameServerGroup</code> object is returned showing that the activity is listed in <code>SuspendedActions</code>.</p>
32/// <p><b>Learn more</b></p>
33/// <p><a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">Amazon GameLift Servers FleetIQ Guide</a></p>
34#[derive(::std::clone::Clone, ::std::fmt::Debug)]
35pub struct SuspendGameServerGroupFluentBuilder {
36    handle: ::std::sync::Arc<crate::client::Handle>,
37    inner: crate::operation::suspend_game_server_group::builders::SuspendGameServerGroupInputBuilder,
38    config_override: ::std::option::Option<crate::config::Builder>,
39}
40impl
41    crate::client::customize::internal::CustomizableSend<
42        crate::operation::suspend_game_server_group::SuspendGameServerGroupOutput,
43        crate::operation::suspend_game_server_group::SuspendGameServerGroupError,
44    > for SuspendGameServerGroupFluentBuilder
45{
46    fn send(
47        self,
48        config_override: crate::config::Builder,
49    ) -> crate::client::customize::internal::BoxFuture<
50        crate::client::customize::internal::SendResult<
51            crate::operation::suspend_game_server_group::SuspendGameServerGroupOutput,
52            crate::operation::suspend_game_server_group::SuspendGameServerGroupError,
53        >,
54    > {
55        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
56    }
57}
58impl SuspendGameServerGroupFluentBuilder {
59    /// Creates a new `SuspendGameServerGroupFluentBuilder`.
60    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
61        Self {
62            handle,
63            inner: ::std::default::Default::default(),
64            config_override: ::std::option::Option::None,
65        }
66    }
67    /// Access the SuspendGameServerGroup as a reference.
68    pub fn as_input(&self) -> &crate::operation::suspend_game_server_group::builders::SuspendGameServerGroupInputBuilder {
69        &self.inner
70    }
71    /// Sends the request and returns the response.
72    ///
73    /// If an error occurs, an `SdkError` will be returned with additional details that
74    /// can be matched against.
75    ///
76    /// By default, any retryable failures will be retried twice. Retry behavior
77    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
78    /// set when configuring the client.
79    pub async fn send(
80        self,
81    ) -> ::std::result::Result<
82        crate::operation::suspend_game_server_group::SuspendGameServerGroupOutput,
83        ::aws_smithy_runtime_api::client::result::SdkError<
84            crate::operation::suspend_game_server_group::SuspendGameServerGroupError,
85            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
86        >,
87    > {
88        let input = self
89            .inner
90            .build()
91            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
92        let runtime_plugins = crate::operation::suspend_game_server_group::SuspendGameServerGroup::operation_runtime_plugins(
93            self.handle.runtime_plugins.clone(),
94            &self.handle.conf,
95            self.config_override,
96        );
97        crate::operation::suspend_game_server_group::SuspendGameServerGroup::orchestrate(&runtime_plugins, input).await
98    }
99
100    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
101    pub fn customize(
102        self,
103    ) -> crate::client::customize::CustomizableOperation<
104        crate::operation::suspend_game_server_group::SuspendGameServerGroupOutput,
105        crate::operation::suspend_game_server_group::SuspendGameServerGroupError,
106        Self,
107    > {
108        crate::client::customize::CustomizableOperation::new(self)
109    }
110    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
111        self.set_config_override(::std::option::Option::Some(config_override.into()));
112        self
113    }
114
115    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
116        self.config_override = config_override;
117        self
118    }
119    /// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
120    pub fn game_server_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
121        self.inner = self.inner.game_server_group_name(input.into());
122        self
123    }
124    /// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
125    pub fn set_game_server_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
126        self.inner = self.inner.set_game_server_group_name(input);
127        self
128    }
129    /// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
130    pub fn get_game_server_group_name(&self) -> &::std::option::Option<::std::string::String> {
131        self.inner.get_game_server_group_name()
132    }
133    ///
134    /// Appends an item to `SuspendActions`.
135    ///
136    /// To override the contents of this collection use [`set_suspend_actions`](Self::set_suspend_actions).
137    ///
138    /// <p>The activity to suspend for this game server group.</p>
139    pub fn suspend_actions(mut self, input: crate::types::GameServerGroupAction) -> Self {
140        self.inner = self.inner.suspend_actions(input);
141        self
142    }
143    /// <p>The activity to suspend for this game server group.</p>
144    pub fn set_suspend_actions(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::GameServerGroupAction>>) -> Self {
145        self.inner = self.inner.set_suspend_actions(input);
146        self
147    }
148    /// <p>The activity to suspend for this game server group.</p>
149    pub fn get_suspend_actions(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::GameServerGroupAction>> {
150        self.inner.get_suspend_actions()
151    }
152}
aws_sdk_gamelift/operation/suspend_game_server_group/builders.rs

aws_sdk_gamelift/operation/suspend_game_server_group/
builders.rs
