AmazonAutoScalingClient.AttachLoadBalancerTargetGroups Method (AttachLoadBalancerTargetGroupsRequest)

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 AttachLoadBalancerTargetGroups. You can use both the original AttachLoadBalancerTargetGroups API operation and AttachTrafficSources on the same Auto Scaling group.

Attaches one or more target groups to the specified Auto Scaling group.

This operation is used with 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).

To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.

This operation is additive and does not detach existing target groups or Classic Load Balancers 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 AttachLoadBalancerTargetGroupsAsync.

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

Syntax

public virtual AttachLoadBalancerTargetGroupsResponse AttachLoadBalancerTargetGroups(
         AttachLoadBalancerTargetGroupsRequest request
)

Parameters

request: Type: Amazon.AutoScaling.Model.AttachLoadBalancerTargetGroupsRequest

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

Return Value

Type: AttachLoadBalancerTargetGroupsResponse

The response from the AttachLoadBalancerTargetGroups 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 target group to the specified Auto Scaling group.

To attach a target group to an Auto Scaling group


var client = new AmazonAutoScalingClient();
var response = client.AttachLoadBalancerTargetGroups(new AttachLoadBalancerTargetGroupsRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    TargetGroupARNs = new List<string> {
        "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
    }
});

Version Information

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

AmazonAutoScalingClient.AttachLoadBalancerTargetGroups (AttachLoadBalancerTargetGroupsRequest)

Method