Struct aws_sdk_elasticloadbalancing::client::Client

source ·
pub struct Client { /* private fields */ }
Expand description

Client for Elastic Load Balancing

Client for invoking operations on Elastic Load Balancing. Each operation on Elastic Load Balancing is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

§Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_elasticloadbalancing::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_elasticloadbalancing::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

§Using the Client

A client has a function for every operation that can be performed by the service. For example, the ApplySecurityGroupsToLoadBalancer operation has a Client::apply_security_groups_to_load_balancer, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.apply_security_groups_to_load_balancer()
    .load_balancer_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

§Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations§

source§

impl Client

source

pub fn add_tags(&self) -> AddTagsFluentBuilder

Constructs a fluent builder for the AddTags operation.

source§

impl Client

source

pub fn apply_security_groups_to_load_balancer( &self ) -> ApplySecurityGroupsToLoadBalancerFluentBuilder

Constructs a fluent builder for the ApplySecurityGroupsToLoadBalancer operation.

source§

impl Client

source

pub fn attach_load_balancer_to_subnets( &self ) -> AttachLoadBalancerToSubnetsFluentBuilder

Constructs a fluent builder for the AttachLoadBalancerToSubnets operation.

source§

impl Client

source

pub fn configure_health_check(&self) -> ConfigureHealthCheckFluentBuilder

Constructs a fluent builder for the ConfigureHealthCheck operation.

source§

impl Client

Constructs a fluent builder for the CreateAppCookieStickinessPolicy operation.

source§

impl Client

Constructs a fluent builder for the CreateLBCookieStickinessPolicy operation.

source§

impl Client

source

pub fn create_load_balancer(&self) -> CreateLoadBalancerFluentBuilder

Constructs a fluent builder for the CreateLoadBalancer operation.

source§

impl Client

source

pub fn create_load_balancer_listeners( &self ) -> CreateLoadBalancerListenersFluentBuilder

Constructs a fluent builder for the CreateLoadBalancerListeners operation.

source§

impl Client

source

pub fn create_load_balancer_policy( &self ) -> CreateLoadBalancerPolicyFluentBuilder

Constructs a fluent builder for the CreateLoadBalancerPolicy operation.

source§

impl Client

source

pub fn delete_load_balancer(&self) -> DeleteLoadBalancerFluentBuilder

Constructs a fluent builder for the DeleteLoadBalancer operation.

source§

impl Client

source

pub fn delete_load_balancer_listeners( &self ) -> DeleteLoadBalancerListenersFluentBuilder

Constructs a fluent builder for the DeleteLoadBalancerListeners operation.

source§

impl Client

source

pub fn delete_load_balancer_policy( &self ) -> DeleteLoadBalancerPolicyFluentBuilder

Constructs a fluent builder for the DeleteLoadBalancerPolicy operation.

source§

impl Client

source

pub fn deregister_instances_from_load_balancer( &self ) -> DeregisterInstancesFromLoadBalancerFluentBuilder

Constructs a fluent builder for the DeregisterInstancesFromLoadBalancer operation.

source§

impl Client

source

pub fn describe_account_limits(&self) -> DescribeAccountLimitsFluentBuilder

Constructs a fluent builder for the DescribeAccountLimits operation.

source§

impl Client

source

pub fn describe_instance_health(&self) -> DescribeInstanceHealthFluentBuilder

Constructs a fluent builder for the DescribeInstanceHealth operation.

source§

impl Client

source

pub fn describe_load_balancer_attributes( &self ) -> DescribeLoadBalancerAttributesFluentBuilder

Constructs a fluent builder for the DescribeLoadBalancerAttributes operation.

source§

impl Client

source

pub fn describe_load_balancer_policies( &self ) -> DescribeLoadBalancerPoliciesFluentBuilder

Constructs a fluent builder for the DescribeLoadBalancerPolicies operation.

source§

impl Client

source

pub fn describe_load_balancer_policy_types( &self ) -> DescribeLoadBalancerPolicyTypesFluentBuilder

Constructs a fluent builder for the DescribeLoadBalancerPolicyTypes operation.

source§

impl Client

source

pub fn describe_load_balancers(&self) -> DescribeLoadBalancersFluentBuilder

Constructs a fluent builder for the DescribeLoadBalancers operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn describe_tags(&self) -> DescribeTagsFluentBuilder

Constructs a fluent builder for the DescribeTags operation.

source§

impl Client

source

pub fn detach_load_balancer_from_subnets( &self ) -> DetachLoadBalancerFromSubnetsFluentBuilder

Constructs a fluent builder for the DetachLoadBalancerFromSubnets operation.

source§

impl Client

source

pub fn disable_availability_zones_for_load_balancer( &self ) -> DisableAvailabilityZonesForLoadBalancerFluentBuilder

Constructs a fluent builder for the DisableAvailabilityZonesForLoadBalancer operation.

source§

impl Client

source

pub fn enable_availability_zones_for_load_balancer( &self ) -> EnableAvailabilityZonesForLoadBalancerFluentBuilder

Constructs a fluent builder for the EnableAvailabilityZonesForLoadBalancer operation.

source§

impl Client

source

pub fn modify_load_balancer_attributes( &self ) -> ModifyLoadBalancerAttributesFluentBuilder

Constructs a fluent builder for the ModifyLoadBalancerAttributes operation.

source§

impl Client

source

pub fn register_instances_with_load_balancer( &self ) -> RegisterInstancesWithLoadBalancerFluentBuilder

Constructs a fluent builder for the RegisterInstancesWithLoadBalancer operation.

source§

impl Client

source

pub fn remove_tags(&self) -> RemoveTagsFluentBuilder

Constructs a fluent builder for the RemoveTags operation.

source§

impl Client

source

pub fn set_load_balancer_listener_ssl_certificate( &self ) -> SetLoadBalancerListenerSSLCertificateFluentBuilder

Constructs a fluent builder for the SetLoadBalancerListenerSSLCertificate operation.

source§

impl Client

source

pub fn set_load_balancer_policies_for_backend_server( &self ) -> SetLoadBalancerPoliciesForBackendServerFluentBuilder

Constructs a fluent builder for the SetLoadBalancerPoliciesForBackendServer operation.

source§

impl Client

source

pub fn set_load_balancer_policies_of_listener( &self ) -> SetLoadBalancerPoliciesOfListenerFluentBuilder

Constructs a fluent builder for the SetLoadBalancerPoliciesOfListener operation.

source§

impl Client

source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

§Panics

This method will panic in the following cases:

  • Retries or timeouts are enabled without a sleep_impl configured.
  • Identity caching is enabled without a sleep_impl and time_source configured.
  • No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

source

pub fn config(&self) -> &Config

Returns the client’s configuration.

source§

impl Client

source

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

§Panics
  • This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
  • 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.

Trait Implementations§

source§

impl Clone for Client

source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Client

source§

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

Formats the value using the given formatter. Read more
source§

impl Waiters for Client

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more