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.

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_elasticloadbalancingv2::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::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_elasticloadbalancingv2::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_elasticloadbalancingv2::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AddListenerCertificates operation.

Constructs a fluent builder for the AddTags operation.

Constructs a fluent builder for the CreateListener operation.

Constructs a fluent builder for the CreateLoadBalancer operation.

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

      The name of the load balancer.

      This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with “internal-”.

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

      The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

      [Application Load Balancers] You must specify subnets from at least two Availability Zones.

      [Application Load Balancers on Outposts] You must specify one Outpost subnet.

      [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

      [Network Load Balancers] You can specify subnets from one or more Availability Zones.

      [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.

    • subnet_mappings(Vec<SubnetMapping>) / set_subnet_mappings(Option<Vec<SubnetMapping>>):

      The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

      [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.

      [Application Load Balancers on Outposts] You must specify one Outpost subnet.

      [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

      [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.

      [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.

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

      [Application Load Balancers] The IDs of the security groups for the load balancer.

    • scheme(LoadBalancerSchemeEnum) / set_scheme(Option<LoadBalancerSchemeEnum>):

      The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

      The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

      The default is an Internet-facing load balancer.

      You cannot specify a scheme for a Gateway Load Balancer.

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

      The tags to assign to the load balancer.

    • r#type(LoadBalancerTypeEnum) / set_type(Option<LoadBalancerTypeEnum>):

      The type of load balancer. The default is application.

    • ip_address_type(IpAddressType) / set_ip_address_type(Option<IpAddressType>):

      The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

    • customer_owned_ipv4_pool(impl Into<String>) / set_customer_owned_ipv4_pool(Option<String>):

      [Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool).

  • On success, responds with CreateLoadBalancerOutput with field(s):
  • On failure, responds with SdkError<CreateLoadBalancerError>

Constructs a fluent builder for the CreateRule operation.

Constructs a fluent builder for the CreateTargetGroup operation.

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

      The name of the target group.

      This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.

    • protocol(ProtocolEnum) / set_protocol(Option<ProtocolEnum>):

      The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply.

    • protocol_version(impl Into<String>) / set_protocol_version(Option<String>):

      [HTTP/HTTPS protocol] The protocol version. Specify GRPC to send requests to targets using gRPC. Specify HTTP2 to send requests to targets using HTTP/2. The default is HTTP1, which sends requests to targets using HTTP/1.1.

    • port(i32) / set_port(Option<i32>):

      The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.

    • vpc_id(impl Into<String>) / set_vpc_id(Option<String>):

      The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required.

    • health_check_protocol(ProtocolEnum) / set_health_check_protocol(Option<ProtocolEnum>):

      The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

    • health_check_port(impl Into<String>) / set_health_check_port(Option<String>):

      The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is traffic-port, which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.

    • health_check_enabled(bool) / set_health_check_enabled(Option<bool>):

      Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.

    • health_check_path(impl Into<String>) / set_health_check_path(Option<String>):

      [HTTP/HTTPS health checks] The destination for health checks on the targets.

      [HTTP1 or HTTP2 protocol version] The ping path. The default is /.

      [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.

    • health_check_interval_seconds(i32) / set_health_check_interval_seconds(Option<i32>):

      The approximate amount of time, in seconds, between health checks of an individual target. If the target group protocol is TCP, TLS, UDP, or TCP_UDP, the supported values are 10 and 30 seconds. If the target group protocol is HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is lambda, the default is 35 seconds.

    • health_check_timeout_seconds(i32) / set_health_check_timeout_seconds(Option<i32>):

      The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP, HTTPS, or GENEVE, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is lambda, the default is 30 seconds.

    • healthy_threshold_count(i32) / set_healthy_threshold_count(Option<i32>):

      The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP, TLS, or GENEVE, the default is 3. If the target type is lambda, the default is 5.

    • unhealthy_threshold_count(i32) / set_unhealthy_threshold_count(Option<i32>):

      The number of consecutive health check failures required before considering a target unhealthy. If the target group protocol is HTTP or HTTPS, the default is 2. If the target group protocol is TCP or TLS, this value must be the same as the healthy threshold count. If the target group protocol is GENEVE, the default is 3. If the target type is lambda, the default is 2.

    • matcher(Matcher) / set_matcher(Option<Matcher>):

      [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.

    • target_type(TargetTypeEnum) / set_target_type(Option<TargetTypeEnum>):

      The type of target that you must specify when registering targets with this target group. You can’t specify targets for a target group using more than one target type.

      • instance - Register targets by instance ID. This is the default value.

      • ip - Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can’t specify publicly routable IP addresses.

      • lambda - Register a single Lambda function as a target.

      • alb - Register a single Application Load Balancer as a target.

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

      The tags to assign to the target group.

    • ip_address_type(TargetGroupIpAddressTypeEnum) / set_ip_address_type(Option<TargetGroupIpAddressTypeEnum>):

      The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

  • On success, responds with CreateTargetGroupOutput with field(s):
  • On failure, responds with SdkError<CreateTargetGroupError>

Constructs a fluent builder for the DeleteListener operation.

Constructs a fluent builder for the DeleteLoadBalancer operation.

Constructs a fluent builder for the DeleteRule operation.

Constructs a fluent builder for the DeleteTargetGroup operation.

Constructs a fluent builder for the DeregisterTargets operation.

Constructs a fluent builder for the DescribeAccountLimits operation.

Constructs a fluent builder for the DescribeListenerCertificates operation.

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

Constructs a fluent builder for the DescribeLoadBalancerAttributes operation.

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

Constructs a fluent builder for the DescribeRules operation.

Constructs a fluent builder for the DescribeSSLPolicies operation.

Constructs a fluent builder for the DescribeTags operation.

Constructs a fluent builder for the DescribeTargetGroupAttributes operation.

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

Constructs a fluent builder for the DescribeTargetHealth operation.

Constructs a fluent builder for the ModifyListener operation.

Constructs a fluent builder for the ModifyLoadBalancerAttributes operation.

Constructs a fluent builder for the ModifyRule operation.

Constructs a fluent builder for the ModifyTargetGroup operation.

Constructs a fluent builder for the ModifyTargetGroupAttributes operation.

Constructs a fluent builder for the RegisterTargets operation.

Constructs a fluent builder for the RemoveListenerCertificates operation.

Constructs a fluent builder for the RemoveTags operation.

Constructs a fluent builder for the SetIpAddressType operation.

Constructs a fluent builder for the SetRulePriorities operation.

Constructs a fluent builder for the SetSecurityGroups operation.

Constructs a fluent builder for the SetSubnets operation.

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

      The Amazon Resource Name (ARN) of the load balancer.

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

      The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

      [Application Load Balancers] You must specify subnets from at least two Availability Zones.

      [Application Load Balancers on Outposts] You must specify one Outpost subnet.

      [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

      [Network Load Balancers] You can specify subnets from one or more Availability Zones.

    • subnet_mappings(Vec<SubnetMapping>) / set_subnet_mappings(Option<Vec<SubnetMapping>>):

      The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

      [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.

      [Application Load Balancers on Outposts] You must specify one Outpost subnet.

      [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

      [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.

    • ip_address_type(IpAddressType) / set_ip_address_type(Option<IpAddressType>):

      [Network Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener. .

  • On success, responds with SetSubnetsOutput with field(s):
  • On failure, responds with SdkError<SetSubnetsError>

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

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

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

Calls U::from(self).

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

The resulting type after obtaining ownership.

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

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

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