aws_sdk_gamelift/operation/describe_fleet_port_settings/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_fleet_port_settings::_describe_fleet_port_settings_output::DescribeFleetPortSettingsOutputBuilder;
3
4pub use crate::operation::describe_fleet_port_settings::_describe_fleet_port_settings_input::DescribeFleetPortSettingsInputBuilder;
5
6impl crate::operation::describe_fleet_port_settings::builders::DescribeFleetPortSettingsInputBuilder {
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::describe_fleet_port_settings::DescribeFleetPortSettingsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_fleet_port_settings::DescribeFleetPortSettingsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_fleet_port_settings();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeFleetPortSettings`.
24///
25/// <p><b>This API works with the following fleet types:</b> EC2, Container</p>
26/// <p>Retrieves a fleet's inbound connection permissions. Connection permissions specify IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game server processes that are running in the fleet must use a port that falls within this range.</p>
27/// <p>Use this operation in the following ways:</p>
28/// <ul>
29/// <li>
30/// <p>To retrieve the port settings for a fleet, identify the fleet's unique identifier.</p></li>
31/// <li>
32/// <p>To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations.</p></li>
33/// </ul>
34/// <p>If successful, a set of <code>IpPermission</code> objects is returned for the requested fleet ID. When specifying a location, this operation returns a pending status. If the requested fleet has been deleted, the result set is empty.</p>
35/// <p><b>Learn more</b></p>
36/// <p><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift Servers fleets</a></p>
37#[derive(::std::clone::Clone, ::std::fmt::Debug)]
38pub struct DescribeFleetPortSettingsFluentBuilder {
39    handle: ::std::sync::Arc<crate::client::Handle>,
40    inner: crate::operation::describe_fleet_port_settings::builders::DescribeFleetPortSettingsInputBuilder,
41    config_override: ::std::option::Option<crate::config::Builder>,
42}
43impl
44    crate::client::customize::internal::CustomizableSend<
45        crate::operation::describe_fleet_port_settings::DescribeFleetPortSettingsOutput,
46        crate::operation::describe_fleet_port_settings::DescribeFleetPortSettingsError,
47    > for DescribeFleetPortSettingsFluentBuilder
48{
49    fn send(
50        self,
51        config_override: crate::config::Builder,
52    ) -> crate::client::customize::internal::BoxFuture<
53        crate::client::customize::internal::SendResult<
54            crate::operation::describe_fleet_port_settings::DescribeFleetPortSettingsOutput,
55            crate::operation::describe_fleet_port_settings::DescribeFleetPortSettingsError,
56        >,
57    > {
58        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
59    }
60}
61impl DescribeFleetPortSettingsFluentBuilder {
62    /// Creates a new `DescribeFleetPortSettingsFluentBuilder`.
63    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
64        Self {
65            handle,
66            inner: ::std::default::Default::default(),
67            config_override: ::std::option::Option::None,
68        }
69    }
70    /// Access the DescribeFleetPortSettings as a reference.
71    pub fn as_input(&self) -> &crate::operation::describe_fleet_port_settings::builders::DescribeFleetPortSettingsInputBuilder {
72        &self.inner
73    }
74    /// Sends the request and returns the response.
75    ///
76    /// If an error occurs, an `SdkError` will be returned with additional details that
77    /// can be matched against.
78    ///
79    /// By default, any retryable failures will be retried twice. Retry behavior
80    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
81    /// set when configuring the client.
82    pub async fn send(
83        self,
84    ) -> ::std::result::Result<
85        crate::operation::describe_fleet_port_settings::DescribeFleetPortSettingsOutput,
86        ::aws_smithy_runtime_api::client::result::SdkError<
87            crate::operation::describe_fleet_port_settings::DescribeFleetPortSettingsError,
88            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
89        >,
90    > {
91        let input = self
92            .inner
93            .build()
94            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
95        let runtime_plugins = crate::operation::describe_fleet_port_settings::DescribeFleetPortSettings::operation_runtime_plugins(
96            self.handle.runtime_plugins.clone(),
97            &self.handle.conf,
98            self.config_override,
99        );
100        crate::operation::describe_fleet_port_settings::DescribeFleetPortSettings::orchestrate(&runtime_plugins, input).await
101    }
102
103    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
104    pub fn customize(
105        self,
106    ) -> crate::client::customize::CustomizableOperation<
107        crate::operation::describe_fleet_port_settings::DescribeFleetPortSettingsOutput,
108        crate::operation::describe_fleet_port_settings::DescribeFleetPortSettingsError,
109        Self,
110    > {
111        crate::client::customize::CustomizableOperation::new(self)
112    }
113    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
114        self.set_config_override(::std::option::Option::Some(config_override.into()));
115        self
116    }
117
118    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
119        self.config_override = config_override;
120        self
121    }
122    /// <p>A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value.</p>
123    pub fn fleet_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
124        self.inner = self.inner.fleet_id(input.into());
125        self
126    }
127    /// <p>A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value.</p>
128    pub fn set_fleet_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
129        self.inner = self.inner.set_fleet_id(input);
130        self
131    }
132    /// <p>A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value.</p>
133    pub fn get_fleet_id(&self) -> &::std::option::Option<::std::string::String> {
134        self.inner.get_fleet_id()
135    }
136    /// <p>A remote location to check for status of port setting updates. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>.</p>
137    pub fn location(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
138        self.inner = self.inner.location(input.into());
139        self
140    }
141    /// <p>A remote location to check for status of port setting updates. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>.</p>
142    pub fn set_location(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
143        self.inner = self.inner.set_location(input);
144        self
145    }
146    /// <p>A remote location to check for status of port setting updates. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>.</p>
147    pub fn get_location(&self) -> &::std::option::Option<::std::string::String> {
148        self.inner.get_location()
149    }
150}