elasticloadbalancing/aws.sdk.kotlin.services.elasticloadbalancing/ElasticLoadBalancingClient

ElasticLoadBalancingClient

interface ElasticLoadBalancingClient : SdkClient

Elastic Load Balancing

A load balancer can distribute incoming traffic across your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered instances and ensures that it routes traffic only to healthy instances. 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 and a protocol and port number for connections from the load balancer to the instances.

Elastic Load Balancing supports three types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers. You can select a load balancer based on your application needs. For more information, see the Elastic Load Balancing User Guide.

This reference covers the 2012-06-01 API, which supports Classic Load Balancers. The 2015-12-01 API supports Application Load Balancers and Network Load Balancers.

To get started, create a load balancer with one or more listeners using CreateLoadBalancer. Register your instances with the load balancer using RegisterInstancesWithLoadBalancer.

All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds with a 200 OK response code.

Properties

Link copied to clipboard
abstract override val config: ElasticLoadBalancingClient.Config

ElasticLoadBalancingClient's configuration

Functions

Link copied to clipboard
abstract suspend fun addTags(input: AddTagsRequest): AddTagsResponse

Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.

Link copied to clipboard
abstract suspend fun applySecurityGroupsToLoadBalancer(input: ApplySecurityGroupsToLoadBalancerRequest): ApplySecurityGroupsToLoadBalancerResponse

Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups.

Link copied to clipboard
abstract suspend fun attachLoadBalancerToSubnets(input: AttachLoadBalancerToSubnetsRequest): AttachLoadBalancerToSubnetsResponse

Adds one or more subnets to the set of configured subnets for the specified load balancer.

Link copied to clipboard
abstract suspend fun configureHealthCheck(input: ConfigureHealthCheckRequest): ConfigureHealthCheckResponse

Specifies the health check settings to use when evaluating the health state of your EC2 instances.

Link copied to clipboard
abstract suspend fun createAppCookieStickinessPolicy(input: CreateAppCookieStickinessPolicyRequest): CreateAppCookieStickinessPolicyResponse

Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.

Link copied to clipboard
abstract suspend fun createLbCookieStickinessPolicy(input: CreateLbCookieStickinessPolicyRequest): CreateLbCookieStickinessPolicyResponse

Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.

Link copied to clipboard
abstract suspend fun createLoadBalancer(input: CreateLoadBalancerRequest): CreateLoadBalancerResponse

Creates a Classic Load Balancer.

Link copied to clipboard
abstract suspend fun createLoadBalancerListeners(input: CreateLoadBalancerListenersRequest): CreateLoadBalancerListenersResponse

Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener.

Link copied to clipboard
abstract suspend fun createLoadBalancerPolicy(input: CreateLoadBalancerPolicyRequest): CreateLoadBalancerPolicyResponse

Creates a policy with the specified attributes for the specified load balancer.

Link copied to clipboard
abstract suspend fun deleteLoadBalancer(input: DeleteLoadBalancerRequest): DeleteLoadBalancerResponse

Deletes the specified load balancer.

Link copied to clipboard
abstract suspend fun deleteLoadBalancerListeners(input: DeleteLoadBalancerListenersRequest): DeleteLoadBalancerListenersResponse

Deletes the specified listeners from the specified load balancer.

Link copied to clipboard
abstract suspend fun deleteLoadBalancerPolicy(input: DeleteLoadBalancerPolicyRequest): DeleteLoadBalancerPolicyResponse

Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.

Link copied to clipboard
abstract suspend fun deregisterInstancesFromLoadBalancer(input: DeregisterInstancesFromLoadBalancerRequest): DeregisterInstancesFromLoadBalancerResponse

Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.

Link copied to clipboard
abstract suspend fun describeAccountLimits(input: DescribeAccountLimitsRequest = DescribeAccountLimitsRequest { }): DescribeAccountLimitsResponse

Describes the current Elastic Load Balancing resource limits for your AWS account.

Link copied to clipboard
abstract suspend fun describeInstanceHealth(input: DescribeInstanceHealthRequest): DescribeInstanceHealthResponse

Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned.

Link copied to clipboard
abstract suspend fun describeLoadBalancerAttributes(input: DescribeLoadBalancerAttributesRequest): DescribeLoadBalancerAttributesResponse

Describes the attributes for the specified load balancer.

Link copied to clipboard
abstract suspend fun describeLoadBalancerPolicies(input: DescribeLoadBalancerPoliciesRequest = DescribeLoadBalancerPoliciesRequest { }): DescribeLoadBalancerPoliciesResponse

Describes the specified policies.

Link copied to clipboard
abstract suspend fun describeLoadBalancerPolicyTypes(input: DescribeLoadBalancerPolicyTypesRequest = DescribeLoadBalancerPolicyTypesRequest { }): DescribeLoadBalancerPolicyTypesResponse

Describes the specified load balancer policy types or all load balancer policy types.

Link copied to clipboard
abstract suspend fun describeLoadBalancers(input: DescribeLoadBalancersRequest = DescribeLoadBalancersRequest { }): DescribeLoadBalancersResponse

Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.

Link copied to clipboard
abstract suspend fun describeTags(input: DescribeTagsRequest): DescribeTagsResponse

Describes the tags associated with the specified load balancers.

Link copied to clipboard
abstract suspend fun detachLoadBalancerFromSubnets(input: DetachLoadBalancerFromSubnetsRequest): DetachLoadBalancerFromSubnetsResponse

Removes the specified subnets from the set of configured subnets for the load balancer.

Link copied to clipboard
abstract suspend fun disableAvailabilityZonesForLoadBalancer(input: DisableAvailabilityZonesForLoadBalancerRequest): DisableAvailabilityZonesForLoadBalancerResponse

Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.

Link copied to clipboard
abstract suspend fun enableAvailabilityZonesForLoadBalancer(input: EnableAvailabilityZonesForLoadBalancerRequest): EnableAvailabilityZonesForLoadBalancerResponse

Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.

Link copied to clipboard
abstract suspend fun modifyLoadBalancerAttributes(input: ModifyLoadBalancerAttributesRequest): ModifyLoadBalancerAttributesResponse

Modifies the attributes of the specified load balancer.

Link copied to clipboard
abstract suspend fun registerInstancesWithLoadBalancer(input: RegisterInstancesWithLoadBalancerRequest): RegisterInstancesWithLoadBalancerResponse

Adds the specified instances to the specified load balancer.

Link copied to clipboard
abstract suspend fun removeTags(input: RemoveTagsRequest): RemoveTagsResponse

Removes one or more tags from the specified load balancer.

Link copied to clipboard
abstract suspend fun setLoadBalancerListenerSslCertificate(input: SetLoadBalancerListenerSslCertificateRequest): SetLoadBalancerListenerSslCertificateResponse

Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.

Link copied to clipboard
abstract suspend fun setLoadBalancerPoliciesForBackendServer(input: SetLoadBalancerPoliciesForBackendServerRequest): SetLoadBalancerPoliciesForBackendServerResponse

Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the instance ports; this policy type is composed of multiple public key policies.

Link copied to clipboard
abstract suspend fun setLoadBalancerPoliciesOfListener(input: SetLoadBalancerPoliciesOfListenerRequest): SetLoadBalancerPoliciesOfListenerResponse

Replaces the current set of policies for the specified load balancer port with the specified set of policies.

Inherited functions

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.addTags(crossinline block: AddTagsRequest.Builder.() -> Unit): AddTagsResponse

Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.applySecurityGroupsToLoadBalancer(crossinline block: ApplySecurityGroupsToLoadBalancerRequest.Builder.() -> Unit): ApplySecurityGroupsToLoadBalancerResponse

Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.attachLoadBalancerToSubnets(crossinline block: AttachLoadBalancerToSubnetsRequest.Builder.() -> Unit): AttachLoadBalancerToSubnetsResponse

Adds one or more subnets to the set of configured subnets for the specified load balancer.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.configureHealthCheck(crossinline block: ConfigureHealthCheckRequest.Builder.() -> Unit): ConfigureHealthCheckResponse

Specifies the health check settings to use when evaluating the health state of your EC2 instances.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.createAppCookieStickinessPolicy(crossinline block: CreateAppCookieStickinessPolicyRequest.Builder.() -> Unit): CreateAppCookieStickinessPolicyResponse

Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.createLbCookieStickinessPolicy(crossinline block: CreateLbCookieStickinessPolicyRequest.Builder.() -> Unit): CreateLbCookieStickinessPolicyResponse

Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.createLoadBalancer(crossinline block: CreateLoadBalancerRequest.Builder.() -> Unit): CreateLoadBalancerResponse

Creates a Classic Load Balancer.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.createLoadBalancerListeners(crossinline block: CreateLoadBalancerListenersRequest.Builder.() -> Unit): CreateLoadBalancerListenersResponse

Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.createLoadBalancerPolicy(crossinline block: CreateLoadBalancerPolicyRequest.Builder.() -> Unit): CreateLoadBalancerPolicyResponse

Creates a policy with the specified attributes for the specified load balancer.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.deleteLoadBalancer(crossinline block: DeleteLoadBalancerRequest.Builder.() -> Unit): DeleteLoadBalancerResponse

Deletes the specified load balancer.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.deleteLoadBalancerListeners(crossinline block: DeleteLoadBalancerListenersRequest.Builder.() -> Unit): DeleteLoadBalancerListenersResponse

Deletes the specified listeners from the specified load balancer.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.deleteLoadBalancerPolicy(crossinline block: DeleteLoadBalancerPolicyRequest.Builder.() -> Unit): DeleteLoadBalancerPolicyResponse

Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.deregisterInstancesFromLoadBalancer(crossinline block: DeregisterInstancesFromLoadBalancerRequest.Builder.() -> Unit): DeregisterInstancesFromLoadBalancerResponse

Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.describeAccountLimits(crossinline block: DescribeAccountLimitsRequest.Builder.() -> Unit): DescribeAccountLimitsResponse

Describes the current Elastic Load Balancing resource limits for your AWS account.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.describeInstanceHealth(crossinline block: DescribeInstanceHealthRequest.Builder.() -> Unit): DescribeInstanceHealthResponse

Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.describeLoadBalancerAttributes(crossinline block: DescribeLoadBalancerAttributesRequest.Builder.() -> Unit): DescribeLoadBalancerAttributesResponse

Describes the attributes for the specified load balancer.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.describeLoadBalancerPolicyTypes(crossinline block: DescribeLoadBalancerPolicyTypesRequest.Builder.() -> Unit): DescribeLoadBalancerPolicyTypesResponse

Describes the specified load balancer policy types or all load balancer policy types.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.describeLoadBalancers(crossinline block: DescribeLoadBalancersRequest.Builder.() -> Unit): DescribeLoadBalancersResponse

Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.describeTags(crossinline block: DescribeTagsRequest.Builder.() -> Unit): DescribeTagsResponse

Describes the tags associated with the specified load balancers.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.detachLoadBalancerFromSubnets(crossinline block: DetachLoadBalancerFromSubnetsRequest.Builder.() -> Unit): DetachLoadBalancerFromSubnetsResponse

Removes the specified subnets from the set of configured subnets for the load balancer.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.disableAvailabilityZonesForLoadBalancer(crossinline block: DisableAvailabilityZonesForLoadBalancerRequest.Builder.() -> Unit): DisableAvailabilityZonesForLoadBalancerResponse

Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.enableAvailabilityZonesForLoadBalancer(crossinline block: EnableAvailabilityZonesForLoadBalancerRequest.Builder.() -> Unit): EnableAvailabilityZonesForLoadBalancerResponse

Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.modifyLoadBalancerAttributes(crossinline block: ModifyLoadBalancerAttributesRequest.Builder.() -> Unit): ModifyLoadBalancerAttributesResponse

Modifies the attributes of the specified load balancer.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.registerInstancesWithLoadBalancer(crossinline block: RegisterInstancesWithLoadBalancerRequest.Builder.() -> Unit): RegisterInstancesWithLoadBalancerResponse

Adds the specified instances to the specified load balancer.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.removeTags(crossinline block: RemoveTagsRequest.Builder.() -> Unit): RemoveTagsResponse

Removes one or more tags from the specified load balancer.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.setLoadBalancerListenerSslCertificate(crossinline block: SetLoadBalancerListenerSslCertificateRequest.Builder.() -> Unit): SetLoadBalancerListenerSslCertificateResponse

Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.setLoadBalancerPoliciesForBackendServer(crossinline block: SetLoadBalancerPoliciesForBackendServerRequest.Builder.() -> Unit): SetLoadBalancerPoliciesForBackendServerResponse

Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the instance ports; this policy type is composed of multiple public key policies.

Link copied to clipboard
inline suspend fun ElasticLoadBalancingClient.setLoadBalancerPoliciesOfListener(crossinline block: SetLoadBalancerPoliciesOfListenerRequest.Builder.() -> Unit): SetLoadBalancerPoliciesOfListenerResponse

Replaces the current set of policies for the specified load balancer port with the specified set of policies.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun ElasticLoadBalancingClient.withConfig(block: ElasticLoadBalancingClient.Config.Builder.() -> Unit): ElasticLoadBalancingClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.

© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved. Generated by dokka