aws_sdk_elasticloadbalancing/
client.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[derive(Debug)]
3pub(crate) struct Handle {
4    pub(crate) conf: crate::Config,
5    #[allow(dead_code)] // unused when a service does not provide any operations
6    pub(crate) runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
7}
8
9/// Client for Elastic Load Balancing
10///
11/// Client for invoking operations on Elastic Load Balancing. Each operation on Elastic Load Balancing is a method on this
12/// this struct. `.send()` MUST be invoked on the generated operations to dispatch the request to the service.
13/// ## Constructing a `Client`
14///
15/// A [`Config`] is required to construct a client. For most use cases, the [`aws-config`]
16/// crate should be used to automatically resolve this config using
17/// [`aws_config::load_from_env()`], since this will resolve an [`SdkConfig`] which can be shared
18/// across multiple different AWS SDK clients. This config resolution process can be customized
19/// by calling [`aws_config::from_env()`] instead, which returns a [`ConfigLoader`] that uses
20/// the [builder pattern] to customize the default config.
21///
22/// In the simplest case, creating a client looks as follows:
23/// ```rust,no_run
24/// # async fn wrapper() {
25/// let config = aws_config::load_from_env().await;
26/// let client = aws_sdk_elasticloadbalancing::Client::new(&config);
27/// # }
28/// ```
29///
30/// Occasionally, SDKs may have additional service-specific values that can be set on the [`Config`] that
31/// is absent from [`SdkConfig`], or slightly different settings for a specific client may be desired.
32/// The [`Builder`](crate::config::Builder) struct implements `From<&SdkConfig>`, so setting these specific settings can be
33/// done as follows:
34///
35/// ```rust,no_run
36/// # async fn wrapper() {
37/// let sdk_config = ::aws_config::load_from_env().await;
38/// let config = aws_sdk_elasticloadbalancing::config::Builder::from(&sdk_config)
39/// # /*
40///     .some_service_specific_setting("value")
41/// # */
42///     .build();
43/// # }
44/// ```
45///
46/// See the [`aws-config` docs] and [`Config`] for more information on customizing configuration.
47///
48/// _Note:_ Client construction is expensive due to connection thread pool initialization, and should
49/// be done once at application start-up.
50///
51/// [`Config`]: crate::Config
52/// [`ConfigLoader`]: https://docs.rs/aws-config/*/aws_config/struct.ConfigLoader.html
53/// [`SdkConfig`]: https://docs.rs/aws-config/*/aws_config/struct.SdkConfig.html
54/// [`aws-config` docs]: https://docs.rs/aws-config/*
55/// [`aws-config`]: https://crates.io/crates/aws-config
56/// [`aws_config::from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.from_env.html
57/// [`aws_config::load_from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.load_from_env.html
58/// [builder pattern]: https://rust-lang.github.io/api-guidelines/type-safety.html#builders-enable-construction-of-complex-values-c-builder
59/// # Using the `Client`
60///
61/// A client has a function for every operation that can be performed by the service.
62/// For example, the [`ApplySecurityGroupsToLoadBalancer`](crate::operation::apply_security_groups_to_load_balancer) operation has
63/// a [`Client::apply_security_groups_to_load_balancer`], function which returns a builder for that operation.
64/// The fluent builder ultimately has a `send()` function that returns an async future that
65/// returns a result, as illustrated below:
66///
67/// ```rust,ignore
68/// let result = client.apply_security_groups_to_load_balancer()
69///     .load_balancer_name("example")
70///     .send()
71///     .await;
72/// ```
73///
74/// The underlying HTTP requests that get made by this can be modified with the `customize_operation`
75/// function on the fluent builder. See the [`customize`](crate::client::customize) module for more
76/// information.
77/// # Waiters
78///
79/// This client provides `wait_until` methods behind the [`Waiters`](crate::client::Waiters) trait.
80/// To use them, simply import the trait, and then call one of the `wait_until` methods. This will
81/// return a waiter fluent builder that takes various parameters, which are documented on the builder
82/// type. Once parameters have been provided, the `wait` method can be called to initiate waiting.
83///
84/// For example, if there was a `wait_until_thing` method, it could look like:
85/// ```rust,ignore
86/// let result = client.wait_until_thing()
87///     .thing_id("someId")
88///     .wait(Duration::from_secs(120))
89///     .await;
90/// ```
91#[derive(::std::clone::Clone, ::std::fmt::Debug)]
92pub struct Client {
93    handle: ::std::sync::Arc<Handle>,
94}
95
96impl Client {
97    /// Creates a new client from the service [`Config`](crate::Config).
98    ///
99    /// # Panics
100    ///
101    /// This method will panic in the following cases:
102    ///
103    /// - Retries or timeouts are enabled without a `sleep_impl` configured.
104    /// - Identity caching is enabled without a `sleep_impl` and `time_source` configured.
105    /// - No `behavior_version` is provided.
106    ///
107    /// The panic message for each of these will have instructions on how to resolve them.
108    #[track_caller]
109    pub fn from_conf(conf: crate::Config) -> Self {
110        let handle = Handle {
111            conf: conf.clone(),
112            runtime_plugins: crate::config::base_client_runtime_plugins(conf),
113        };
114        if let Err(err) = Self::validate_config(&handle) {
115            panic!("Invalid client configuration: {err}");
116        }
117        Self {
118            handle: ::std::sync::Arc::new(handle),
119        }
120    }
121
122    /// Returns the client's configuration.
123    pub fn config(&self) -> &crate::Config {
124        &self.handle.conf
125    }
126
127    fn validate_config(handle: &Handle) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
128        let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
129        handle
130            .runtime_plugins
131            .apply_client_configuration(&mut cfg)?
132            .validate_base_client_config(&cfg)?;
133        Ok(())
134    }
135}
136
137///
138/// Waiter functions for the client.
139///
140/// Import this trait to get `wait_until` methods on the client.
141///
142pub trait Waiters {
143    /// Wait for `any_instance_in_service`
144    fn wait_until_any_instance_in_service(&self) -> crate::waiters::any_instance_in_service::AnyInstanceInServiceFluentBuilder;
145    /// Wait for `instance_deregistered`
146    fn wait_until_instance_deregistered(&self) -> crate::waiters::instance_deregistered::InstanceDeregisteredFluentBuilder;
147    /// Wait for `instance_in_service`
148    fn wait_until_instance_in_service(&self) -> crate::waiters::instance_in_service::InstanceInServiceFluentBuilder;
149}
150impl Waiters for Client {
151    fn wait_until_any_instance_in_service(&self) -> crate::waiters::any_instance_in_service::AnyInstanceInServiceFluentBuilder {
152        crate::waiters::any_instance_in_service::AnyInstanceInServiceFluentBuilder::new(self.handle.clone())
153    }
154    fn wait_until_instance_deregistered(&self) -> crate::waiters::instance_deregistered::InstanceDeregisteredFluentBuilder {
155        crate::waiters::instance_deregistered::InstanceDeregisteredFluentBuilder::new(self.handle.clone())
156    }
157    fn wait_until_instance_in_service(&self) -> crate::waiters::instance_in_service::InstanceInServiceFluentBuilder {
158        crate::waiters::instance_in_service::InstanceInServiceFluentBuilder::new(self.handle.clone())
159    }
160}
161
162impl Client {
163    /// Creates a new client from an [SDK Config](::aws_types::sdk_config::SdkConfig).
164    ///
165    /// # Panics
166    ///
167    /// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
168    ///     the `sleep_impl` on the Config passed into this function to fix it.
169    /// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
170    ///     `http_connector` on the Config passed into this function to fix it.
171    /// - This method will panic if no `BehaviorVersion` is provided. If you experience this panic, set `behavior_version` on the Config or enable the `behavior-version-latest` Cargo feature.
172    #[track_caller]
173    pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
174        Self::from_conf(sdk_config.into())
175    }
176}
177
178mod add_tags;
179
180mod apply_security_groups_to_load_balancer;
181
182mod attach_load_balancer_to_subnets;
183
184mod configure_health_check;
185
186mod create_app_cookie_stickiness_policy;
187
188mod create_lb_cookie_stickiness_policy;
189
190mod create_load_balancer;
191
192mod create_load_balancer_listeners;
193
194mod create_load_balancer_policy;
195
196/// Operation customization and supporting types.
197///
198/// The underlying HTTP requests made during an operation can be customized
199/// by calling the `customize()` method on the builder returned from a client
200/// operation call. For example, this can be used to add an additional HTTP header:
201///
202/// ```ignore
203/// # async fn wrapper() -> ::std::result::Result<(), aws_sdk_elasticloadbalancing::Error> {
204/// # let client: aws_sdk_elasticloadbalancing::Client = unimplemented!();
205/// use ::http::header::{HeaderName, HeaderValue};
206///
207/// let result = client.add_tags()
208///     .customize()
209///     .mutate_request(|req| {
210///         // Add `x-example-header` with value
211///         req.headers_mut()
212///             .insert(
213///                 HeaderName::from_static("x-example-header"),
214///                 HeaderValue::from_static("1"),
215///             );
216///     })
217///     .send()
218///     .await;
219/// # }
220/// ```
221pub mod customize;
222
223mod delete_load_balancer;
224
225mod delete_load_balancer_listeners;
226
227mod delete_load_balancer_policy;
228
229mod deregister_instances_from_load_balancer;
230
231mod describe_account_limits;
232
233mod describe_instance_health;
234
235mod describe_load_balancer_attributes;
236
237mod describe_load_balancer_policies;
238
239mod describe_load_balancer_policy_types;
240
241mod describe_load_balancers;
242
243mod describe_tags;
244
245mod detach_load_balancer_from_subnets;
246
247mod disable_availability_zones_for_load_balancer;
248
249mod enable_availability_zones_for_load_balancer;
250
251mod modify_load_balancer_attributes;
252
253mod register_instances_with_load_balancer;
254
255mod remove_tags;
256
257mod set_load_balancer_listener_ssl_certificate;
258
259mod set_load_balancer_policies_for_backend_server;
260
261mod set_load_balancer_policies_of_listener;