Expand description
A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.
Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, Gateway Load Balancers, and Classic Load Balancers. This reference covers the following load balancer types:
-
Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.
-
Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.
-
Gateway Load Balancer - Operates at the network layer (layer 3).
For more information, see the Elastic Load Balancing User Guide.
All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.
If you’re using the service, you’re probably looking for ElbClient and Elb.
Structs§
- Action
Information about an action.
Each rule must include exactly one of the following types of actions:
forward,fixed-response, orredirect, and it must be the last action to be performed.- AddListener
Certificates Input - AddListener
Certificates Output - AddTags
Input - AddTags
Output - Authenticate
Cognito Action Config Request parameters to use when integrating with Amazon Cognito to authenticate users.
- Authenticate
Oidc Action Config Request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.
- Availability
Zone Information about an Availability Zone.
- Certificate
Information about an SSL server certificate.
- Cipher
Information about a cipher used in a policy.
- Create
Listener Input - Create
Listener Output - Create
Load Balancer Input - Create
Load Balancer Output - Create
Rule Input - Create
Rule Output - Create
Target Group Input - Create
Target Group Output - Delete
Listener Input - Delete
Listener Output - Delete
Load Balancer Input - Delete
Load Balancer Output - Delete
Rule Input - Delete
Rule Output - Delete
Target Group Input - Delete
Target Group Output - Deregister
Targets Input - Deregister
Targets Output - Describe
Account Limits Input - Describe
Account Limits Output - Describe
Listener Certificates Input - Describe
Listener Certificates Output - Describe
Listeners Input - Describe
Listeners Output - Describe
Load Balancer Attributes Input - Describe
Load Balancer Attributes Output - Describe
Load Balancers Input - Describe
Load Balancers Output - Describe
Rules Input - Describe
Rules Output - DescribeSSL
Policies Input - DescribeSSL
Policies Output - Describe
Tags Input - Describe
Tags Output - Describe
Target Group Attributes Input - Describe
Target Group Attributes Output - Describe
Target Groups Input - Describe
Target Groups Output - Describe
Target Health Input - Describe
Target Health Output - ElbClient
- A client for the Elastic Load Balancing v2 API.
- Fixed
Response Action Config Information about an action that returns a custom HTTP response.
- Forward
Action Config Information about a forward action.
- Host
Header Condition Config Information about a host header condition.
- Http
Header Condition Config Information about an HTTP header condition.
There is a set of standard HTTP header fields. You can also define custom HTTP header fields.
- Http
Request Method Condition Config Information about an HTTP method condition.
HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the HTTP Method Registry. You can also define custom HTTP methods.
- Limit
Information about an Elastic Load Balancing resource limit for your AWS account.
- Listener
Information about a listener.
- Load
Balancer Information about a load balancer.
- Load
Balancer Address Information about a static IP address for a load balancer.
- Load
Balancer Attribute Information about a load balancer attribute.
- Load
Balancer State Information about the state of the load balancer.
- Matcher
The codes to use when checking for a successful response from a target. If the protocol version is gRPC, these are gRPC codes. Otherwise, these are HTTP codes.
- Modify
Listener Input - Modify
Listener Output - Modify
Load Balancer Attributes Input - Modify
Load Balancer Attributes Output - Modify
Rule Input - Modify
Rule Output - Modify
Target Group Attributes Input - Modify
Target Group Attributes Output - Modify
Target Group Input - Modify
Target Group Output - Path
Pattern Condition Config Information about a path pattern condition.
- Query
String Condition Config Information about a query string condition.
The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded.
- Query
String KeyValue Pair Information about a key/value pair.
- Redirect
Action Config Information about a redirect action.
A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.
You can reuse URI components using the following reserved keywords:
-
#{protocol}
-
#{host}
-
#{port}
-
#{path} (the leading "/" is removed)
-
#{query}
For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz".
-
- Register
Targets Input - Register
Targets Output - Remove
Listener Certificates Input - Remove
Listener Certificates Output - Remove
Tags Input - Remove
Tags Output - Rule
Information about a rule.
- Rule
Condition Information about a condition for a rule.
Each rule can optionally include up to one of each of the following conditions:
http-request-method,host-header,path-pattern, andsource-ip. Each rule can also optionally include one or more of each of the following conditions:http-headerandquery-string.- Rule
Priority Pair Information about the priorities for the rules for a listener.
- SetIp
Address Type Input - SetIp
Address Type Output - SetRule
Priorities Input - SetRule
Priorities Output - SetSecurity
Groups Input - SetSecurity
Groups Output - SetSubnets
Input - SetSubnets
Output - Source
IpCondition Config Information about a source IP condition.
You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.
- SslPolicy
Information about a policy used for SSL negotiation.
- Subnet
Mapping Information about a subnet mapping.
- Tag
Information about a tag.
- TagDescription
The tags associated with a resource.
- Target
Description Information about a target.
- Target
Group Information about a target group.
- Target
Group Attribute Information about a target group attribute.
- Target
Group Stickiness Config Information about the target group stickiness for a rule.
- Target
Group Tuple Information about how traffic will be distributed between multiple target groups in a forward rule.
- Target
Health Information about the current health of a target.
- Target
Health Description Information about the health of a target.
Enums§
- AddListener
Certificates Error - Errors returned by AddListenerCertificates
- AddTags
Error - Errors returned by AddTags
- Create
Listener Error - Errors returned by CreateListener
- Create
Load Balancer Error - Errors returned by CreateLoadBalancer
- Create
Rule Error - Errors returned by CreateRule
- Create
Target Group Error - Errors returned by CreateTargetGroup
- Delete
Listener Error - Errors returned by DeleteListener
- Delete
Load Balancer Error - Errors returned by DeleteLoadBalancer
- Delete
Rule Error - Errors returned by DeleteRule
- Delete
Target Group Error - Errors returned by DeleteTargetGroup
- Deregister
Targets Error - Errors returned by DeregisterTargets
- Describe
Account Limits Error - Errors returned by DescribeAccountLimits
- Describe
Listener Certificates Error - Errors returned by DescribeListenerCertificates
- Describe
Listeners Error - Errors returned by DescribeListeners
- Describe
Load Balancer Attributes Error - Errors returned by DescribeLoadBalancerAttributes
- Describe
Load Balancers Error - Errors returned by DescribeLoadBalancers
- Describe
Rules Error - Errors returned by DescribeRules
- DescribeSSL
Policies Error - Errors returned by DescribeSSLPolicies
- Describe
Tags Error - Errors returned by DescribeTags
- Describe
Target Group Attributes Error - Errors returned by DescribeTargetGroupAttributes
- Describe
Target Groups Error - Errors returned by DescribeTargetGroups
- Describe
Target Health Error - Errors returned by DescribeTargetHealth
- Modify
Listener Error - Errors returned by ModifyListener
- Modify
Load Balancer Attributes Error - Errors returned by ModifyLoadBalancerAttributes
- Modify
Rule Error - Errors returned by ModifyRule
- Modify
Target Group Attributes Error - Errors returned by ModifyTargetGroupAttributes
- Modify
Target Group Error - Errors returned by ModifyTargetGroup
- Register
Targets Error - Errors returned by RegisterTargets
- Remove
Listener Certificates Error - Errors returned by RemoveListenerCertificates
- Remove
Tags Error - Errors returned by RemoveTags
- SetIp
Address Type Error - Errors returned by SetIpAddressType
- SetRule
Priorities Error - Errors returned by SetRulePriorities
- SetSecurity
Groups Error - Errors returned by SetSecurityGroups
- SetSubnets
Error - Errors returned by SetSubnets
Traits§
- Elb
- Trait representing the capabilities of the Elastic Load Balancing v2 API. Elastic Load Balancing v2 clients implement this trait.