AmazonAutoScalingClient.AttachLoadBalancers Method (AttachLoadBalancersRequest)

This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to simplify how you manage traffic sources. However, we continue to support AttachLoadBalancers. You can use both the original AttachLoadBalancers API operation and AttachTrafficSources on the same Auto Scaling group.

Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers.

To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling group, call the DetachLoadBalancers API.

This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group.

For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to AttachLoadBalancersAsync.

Namespace: Amazon.AutoScaling
Assembly: AWSSDK.AutoScaling.dll
Version: 3.x.y.z

Syntax

public virtual AttachLoadBalancersResponse AttachLoadBalancers(
         AttachLoadBalancersRequest request
)

Parameters

request: Type: Amazon.AutoScaling.Model.AttachLoadBalancersRequest

Container for the necessary parameters to execute the AttachLoadBalancers service method.

Return Value

Type: AttachLoadBalancersResponse

The response from the AttachLoadBalancers service method, as returned by AutoScaling.

Exceptions

Exception	Condition
ResourceContentionException	You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).
ServiceLinkedRoleFailureException	The service-linked role is not yet ready for use.

Examples

This example attaches the specified load balancer to the specified Auto Scaling group.

To attach a load balancer to an Auto Scaling group


var client = new AmazonAutoScalingClient();
var response = client.AttachLoadBalancers(new AttachLoadBalancersRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    LoadBalancerNames = new List<string> {
        "my-load-balancer"
    }
});

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonAutoScalingClient.AttachLoadBalancers (AttachLoadBalancersRequest)

Method