Struct aws_sdk_elasticloadbalancing::client::Client

pub struct Client { /* private fields */ }

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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_elasticloadbalancing::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_elasticloadbalancing::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_elasticloadbalancing::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn add_tags(&self) -> AddTags

Constructs a fluent builder for the AddTags operation.

• The fluent builder is configurable:
  • load_balancer_names(Vec<String>) / set_load_balancer_names(Option<Vec<String>>):

    The name of the load balancer. You can specify one load balancer only.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    The tags.

• On success, responds with AddTagsOutput
• On failure, responds with SdkError<AddTagsError>

pub fn apply_security_groups_to_load_balancer(
    &self
) -> ApplySecurityGroupsToLoadBalancer

Constructs a fluent builder for the ApplySecurityGroupsToLoadBalancer operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • security_groups(Vec<String>) / set_security_groups(Option<Vec<String>>):

    The IDs of the security groups to associate with the load balancer. Note that you cannot specify the name of the security group.

• On success, responds with ApplySecurityGroupsToLoadBalancerOutput with field(s):
  • security_groups(Option<Vec<String>>):

    The IDs of the security groups associated with the load balancer.

• On failure, responds with SdkError<ApplySecurityGroupsToLoadBalancerError>

pub fn attach_load_balancer_to_subnets(&self) -> AttachLoadBalancerToSubnets

Constructs a fluent builder for the AttachLoadBalancerToSubnets operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • subnets(Vec<String>) / set_subnets(Option<Vec<String>>):

    The IDs of the subnets to add. You can add only one subnet per Availability Zone.

• On success, responds with AttachLoadBalancerToSubnetsOutput with field(s):
  • subnets(Option<Vec<String>>):

    The IDs of the subnets attached to the load balancer.

• On failure, responds with SdkError<AttachLoadBalancerToSubnetsError>

pub fn configure_health_check(&self) -> ConfigureHealthCheck

Constructs a fluent builder for the ConfigureHealthCheck operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • health_check(HealthCheck) / set_health_check(Option<HealthCheck>):

    The configuration information.

• On success, responds with ConfigureHealthCheckOutput with field(s):
  • health_check(Option<HealthCheck>):

    The updated health check.

• On failure, responds with SdkError<ConfigureHealthCheckError>

pub fn create_app_cookie_stickiness_policy(
    &self
) -> CreateAppCookieStickinessPolicy

Constructs a fluent builder for the CreateAppCookieStickinessPolicy operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • policy_name(impl Into<String>) / set_policy_name(Option<String>):

    The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.

  • cookie_name(impl Into<String>) / set_cookie_name(Option<String>):

    The name of the application cookie used for stickiness.

• On success, responds with CreateAppCookieStickinessPolicyOutput
• On failure, responds with SdkError<CreateAppCookieStickinessPolicyError>

pub fn create_lb_cookie_stickiness_policy(
    &self
) -> CreateLBCookieStickinessPolicy

Constructs a fluent builder for the CreateLBCookieStickinessPolicy operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • policy_name(impl Into<String>) / set_policy_name(Option<String>):

    The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.

  • cookie_expiration_period(i64) / set_cookie_expiration_period(Option<i64>):

    The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.

• On success, responds with CreateLbCookieStickinessPolicyOutput
• On failure, responds with SdkError<CreateLBCookieStickinessPolicyError>

pub fn create_load_balancer(&self) -> CreateLoadBalancer

Constructs a fluent builder for the CreateLoadBalancer operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

    This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.

  • listeners(Vec<Listener>) / set_listeners(Option<Vec<Listener>>):

    The listeners.

    For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.

  • availability_zones(Vec<String>) / set_availability_zones(Option<Vec<String>>):

    One or more Availability Zones from the same region as the load balancer.

    You must specify at least one Availability Zone.

    You can add more Availability Zones after you create the load balancer using EnableAvailabilityZonesForLoadBalancer.

  • subnets(Vec<String>) / set_subnets(Option<Vec<String>>):

    The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

  • security_groups(Vec<String>) / set_security_groups(Option<Vec<String>>):

    The IDs of the security groups to assign to the load balancer.

  • scheme(impl Into<String>) / set_scheme(Option<String>):

    The type of a load balancer. Valid only for load balancers in a VPC.

    By default, Elastic Load Balancing creates an Internet-facing load balancer with a DNS name that resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Load Balancer Scheme in the Elastic Load Balancing User Guide.

    Specify internal to create a load balancer with a DNS name that resolves to private IP addresses.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    A list of tags to assign to the load balancer.

    For more information about tagging your load balancer, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide.

• On success, responds with CreateLoadBalancerOutput with field(s):
  • dns_name(Option<String>):

    The DNS name of the load balancer.

• On failure, responds with SdkError<CreateLoadBalancerError>

pub fn create_load_balancer_listeners(&self) -> CreateLoadBalancerListeners

Constructs a fluent builder for the CreateLoadBalancerListeners operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • listeners(Vec<Listener>) / set_listeners(Option<Vec<Listener>>):

    The listeners.

• On success, responds with CreateLoadBalancerListenersOutput
• On failure, responds with SdkError<CreateLoadBalancerListenersError>

pub fn create_load_balancer_policy(&self) -> CreateLoadBalancerPolicy

Constructs a fluent builder for the CreateLoadBalancerPolicy operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • policy_name(impl Into<String>) / set_policy_name(Option<String>):

    The name of the load balancer policy to be created. This name must be unique within the set of policies for this load balancer.

  • policy_type_name(impl Into<String>) / set_policy_type_name(Option<String>):

    The name of the base policy type. To get the list of policy types, use DescribeLoadBalancerPolicyTypes.

  • policy_attributes(Vec<PolicyAttribute>) / set_policy_attributes(Option<Vec<PolicyAttribute>>):

    The policy attributes.

• On success, responds with CreateLoadBalancerPolicyOutput
• On failure, responds with SdkError<CreateLoadBalancerPolicyError>

pub fn delete_load_balancer(&self) -> DeleteLoadBalancer

Constructs a fluent builder for the DeleteLoadBalancer operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

• On success, responds with DeleteLoadBalancerOutput
• On failure, responds with SdkError<DeleteLoadBalancerError>

pub fn delete_load_balancer_listeners(&self) -> DeleteLoadBalancerListeners

Constructs a fluent builder for the DeleteLoadBalancerListeners operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • load_balancer_ports(Vec<i32>) / set_load_balancer_ports(Option<Vec<i32>>):

    The client port numbers of the listeners.

• On success, responds with DeleteLoadBalancerListenersOutput
• On failure, responds with SdkError<DeleteLoadBalancerListenersError>

pub fn delete_load_balancer_policy(&self) -> DeleteLoadBalancerPolicy

Constructs a fluent builder for the DeleteLoadBalancerPolicy operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • policy_name(impl Into<String>) / set_policy_name(Option<String>):

    The name of the policy.

• On success, responds with DeleteLoadBalancerPolicyOutput
• On failure, responds with SdkError<DeleteLoadBalancerPolicyError>

pub fn deregister_instances_from_load_balancer(
    &self
) -> DeregisterInstancesFromLoadBalancer

Constructs a fluent builder for the DeregisterInstancesFromLoadBalancer operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • instances(Vec<Instance>) / set_instances(Option<Vec<Instance>>):

    The IDs of the instances.

• On success, responds with DeregisterInstancesFromLoadBalancerOutput with field(s):
  • instances(Option<Vec<Instance>>):

    The remaining instances registered with the load balancer.

• On failure, responds with SdkError<DeregisterInstancesFromLoadBalancerError>

pub fn describe_account_limits(&self) -> DescribeAccountLimits

Constructs a fluent builder for the DescribeAccountLimits operation.

• The fluent builder is configurable:
  • marker(impl Into<String>) / set_marker(Option<String>):

    The marker for the next set of results. (You received this marker from a previous call.)

  • page_size(i32) / set_page_size(Option<i32>):

    The maximum number of results to return with this call.

• On success, responds with DescribeAccountLimitsOutput with field(s):
  • limits(Option<Vec<Limit>>):

    Information about the limits.

  • next_marker(Option<String>):

    The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

• On failure, responds with SdkError<DescribeAccountLimitsError>

pub fn describe_instance_health(&self) -> DescribeInstanceHealth

Constructs a fluent builder for the DescribeInstanceHealth operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • instances(Vec<Instance>) / set_instances(Option<Vec<Instance>>):

    The IDs of the instances.

• On success, responds with DescribeInstanceHealthOutput with field(s):
  • instance_states(Option<Vec<InstanceState>>):

    Information about the health of the instances.

• On failure, responds with SdkError<DescribeInstanceHealthError>

pub fn describe_load_balancer_attributes(
    &self
) -> DescribeLoadBalancerAttributes

Constructs a fluent builder for the DescribeLoadBalancerAttributes operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

• On success, responds with DescribeLoadBalancerAttributesOutput with field(s):
  • load_balancer_attributes(Option<LoadBalancerAttributes>):

    Information about the load balancer attributes.

• On failure, responds with SdkError<DescribeLoadBalancerAttributesError>

pub fn describe_load_balancer_policies(&self) -> DescribeLoadBalancerPolicies

Constructs a fluent builder for the DescribeLoadBalancerPolicies operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • policy_names(Vec<String>) / set_policy_names(Option<Vec<String>>):

    The names of the policies.

• On success, responds with DescribeLoadBalancerPoliciesOutput with field(s):
  • policy_descriptions(Option<Vec<PolicyDescription>>):

    Information about the policies.

• On failure, responds with SdkError<DescribeLoadBalancerPoliciesError>

pub fn describe_load_balancer_policy_types(
    &self
) -> DescribeLoadBalancerPolicyTypes

Constructs a fluent builder for the DescribeLoadBalancerPolicyTypes operation.

• The fluent builder is configurable:
  • policy_type_names(Vec<String>) / set_policy_type_names(Option<Vec<String>>):

    The names of the policy types. If no names are specified, describes all policy types defined by Elastic Load Balancing.

• On success, responds with DescribeLoadBalancerPolicyTypesOutput with field(s):
  • policy_type_descriptions(Option<Vec<PolicyTypeDescription>>):

    Information about the policy types.

• On failure, responds with SdkError<DescribeLoadBalancerPolicyTypesError>

pub fn describe_load_balancers(&self) -> DescribeLoadBalancers

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

• The fluent builder is configurable:
  • load_balancer_names(Vec<String>) / set_load_balancer_names(Option<Vec<String>>):

    The names of the load balancers.

  • marker(impl Into<String>) / set_marker(Option<String>):

    The marker for the next set of results. (You received this marker from a previous call.)

  • page_size(i32) / set_page_size(Option<i32>):

    The maximum number of results to return with this call (a number from 1 to 400). The default is 400.

• On success, responds with DescribeLoadBalancersOutput with field(s):
  • load_balancer_descriptions(Option<Vec<LoadBalancerDescription>>):

    Information about the load balancers.

  • next_marker(Option<String>):

    The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

• On failure, responds with SdkError<DescribeLoadBalancersError>

pub fn describe_tags(&self) -> DescribeTags

Constructs a fluent builder for the DescribeTags operation.

• The fluent builder is configurable:
  • load_balancer_names(Vec<String>) / set_load_balancer_names(Option<Vec<String>>):

    The names of the load balancers.

• On success, responds with DescribeTagsOutput with field(s):
  • tag_descriptions(Option<Vec<TagDescription>>):

    Information about the tags.

• On failure, responds with SdkError<DescribeTagsError>

pub fn detach_load_balancer_from_subnets(&self) -> DetachLoadBalancerFromSubnets

Constructs a fluent builder for the DetachLoadBalancerFromSubnets operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • subnets(Vec<String>) / set_subnets(Option<Vec<String>>):

    The IDs of the subnets.

• On success, responds with DetachLoadBalancerFromSubnetsOutput with field(s):
  • subnets(Option<Vec<String>>):

    The IDs of the remaining subnets for the load balancer.

• On failure, responds with SdkError<DetachLoadBalancerFromSubnetsError>

pub fn disable_availability_zones_for_load_balancer(
    &self
) -> DisableAvailabilityZonesForLoadBalancer

Constructs a fluent builder for the DisableAvailabilityZonesForLoadBalancer operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • availability_zones(Vec<String>) / set_availability_zones(Option<Vec<String>>):

    The Availability Zones.

• On success, responds with DisableAvailabilityZonesForLoadBalancerOutput with field(s):
  • availability_zones(Option<Vec<String>>):

    The remaining Availability Zones for the load balancer.

• On failure, responds with SdkError<DisableAvailabilityZonesForLoadBalancerError>

pub fn enable_availability_zones_for_load_balancer(
    &self
) -> EnableAvailabilityZonesForLoadBalancer

Constructs a fluent builder for the EnableAvailabilityZonesForLoadBalancer operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • availability_zones(Vec<String>) / set_availability_zones(Option<Vec<String>>):

    The Availability Zones. These must be in the same region as the load balancer.

• On success, responds with EnableAvailabilityZonesForLoadBalancerOutput with field(s):
  • availability_zones(Option<Vec<String>>):

    The updated list of Availability Zones for the load balancer.

• On failure, responds with SdkError<EnableAvailabilityZonesForLoadBalancerError>

pub fn modify_load_balancer_attributes(&self) -> ModifyLoadBalancerAttributes

Constructs a fluent builder for the ModifyLoadBalancerAttributes operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • load_balancer_attributes(LoadBalancerAttributes) / set_load_balancer_attributes(Option<LoadBalancerAttributes>):

    The attributes for the load balancer.

• On success, responds with ModifyLoadBalancerAttributesOutput with field(s):
  • load_balancer_name(Option<String>):

    The name of the load balancer.

  • load_balancer_attributes(Option<LoadBalancerAttributes>):

    Information about the load balancer attributes.

• On failure, responds with SdkError<ModifyLoadBalancerAttributesError>

pub fn register_instances_with_load_balancer(
    &self
) -> RegisterInstancesWithLoadBalancer

Constructs a fluent builder for the RegisterInstancesWithLoadBalancer operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • instances(Vec<Instance>) / set_instances(Option<Vec<Instance>>):

    The IDs of the instances.

• On success, responds with RegisterInstancesWithLoadBalancerOutput with field(s):
  • instances(Option<Vec<Instance>>):

    The updated list of instances for the load balancer.

• On failure, responds with SdkError<RegisterInstancesWithLoadBalancerError>

pub fn remove_tags(&self) -> RemoveTags

Constructs a fluent builder for the RemoveTags operation.

• The fluent builder is configurable:
  • load_balancer_names(Vec<String>) / set_load_balancer_names(Option<Vec<String>>):

    The name of the load balancer. You can specify a maximum of one load balancer name.

  • tags(Vec<TagKeyOnly>) / set_tags(Option<Vec<TagKeyOnly>>):

    The list of tag keys to remove.

• On success, responds with RemoveTagsOutput
• On failure, responds with SdkError<RemoveTagsError>

pub fn set_load_balancer_listener_ssl_certificate(
    &self
) -> SetLoadBalancerListenerSSLCertificate

Constructs a fluent builder for the SetLoadBalancerListenerSSLCertificate operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • load_balancer_port(i32) / set_load_balancer_port(i32):

    The port that uses the specified SSL certificate.

  • ssl_certificate_id(impl Into<String>) / set_ssl_certificate_id(Option<String>):

    The Amazon Resource Name (ARN) of the SSL certificate.

• On success, responds with SetLoadBalancerListenerSslCertificateOutput
• On failure, responds with SdkError<SetLoadBalancerListenerSSLCertificateError>

pub fn set_load_balancer_policies_for_backend_server(
    &self
) -> SetLoadBalancerPoliciesForBackendServer

Constructs a fluent builder for the SetLoadBalancerPoliciesForBackendServer operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • instance_port(i32) / set_instance_port(Option<i32>):

    The port number associated with the EC2 instance.

  • policy_names(Vec<String>) / set_policy_names(Option<Vec<String>>):

    The names of the policies. If the list is empty, then all current polices are removed from the EC2 instance.

• On success, responds with SetLoadBalancerPoliciesForBackendServerOutput
• On failure, responds with SdkError<SetLoadBalancerPoliciesForBackendServerError>

pub fn set_load_balancer_policies_of_listener(
    &self
) -> SetLoadBalancerPoliciesOfListener

Constructs a fluent builder for the SetLoadBalancerPoliciesOfListener operation.

• The fluent builder is configurable:
  • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

    The name of the load balancer.

  • load_balancer_port(i32) / set_load_balancer_port(i32):

    The external port of the load balancer.

  • policy_names(Vec<String>) / set_policy_names(Option<Vec<String>>):

    The names of the policies. This list must include all policies to be enabled. If you omit a policy that is currently enabled, it is disabled. If the list is empty, all current policies are disabled.

• On success, responds with SetLoadBalancerPoliciesOfListenerOutput
• On failure, responds with SdkError<SetLoadBalancerPoliciesOfListenerError>

impl Client

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.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

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

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.