1. Packages
  2. AWS
  3. API Docs
  4. autoscaling
  5. Attachment
AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi

aws.autoscaling.Attachment

Explore with Pulumi AI

Attaches a load balancer to an Auto Scaling group.

NOTE on Auto Scaling Groups, Attachments and Traffic Source Attachments: Pulumi provides standalone Attachment (for attaching Classic Load Balancers and Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target groups) and Traffic Source Attachment (for attaching Load Balancers and VPC Lattice target groups) resources and an Auto Scaling Group resource with load_balancers, target_group_arns and traffic_source attributes. Do not use the same traffic source in more than one of these resources. Doing so will cause a conflict of attachments. A lifecycle configuration block can be used to suppress differences if necessary.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

// Create a new load balancer attachment
const example = new aws.autoscaling.Attachment("example", {
    autoscalingGroupName: exampleAwsAutoscalingGroup.id,
    elb: exampleAwsElb.id,
});
Copy
import pulumi
import pulumi_aws as aws

# Create a new load balancer attachment
example = aws.autoscaling.Attachment("example",
    autoscaling_group_name=example_aws_autoscaling_group["id"],
    elb=example_aws_elb["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/autoscaling"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a new load balancer attachment
		_, err := autoscaling.NewAttachment(ctx, "example", &autoscaling.AttachmentArgs{
			AutoscalingGroupName: pulumi.Any(exampleAwsAutoscalingGroup.Id),
			Elb:                  pulumi.Any(exampleAwsElb.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    // Create a new load balancer attachment
    var example = new Aws.AutoScaling.Attachment("example", new()
    {
        AutoscalingGroupName = exampleAwsAutoscalingGroup.Id,
        Elb = exampleAwsElb.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.autoscaling.Attachment;
import com.pulumi.aws.autoscaling.AttachmentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Create a new load balancer attachment
        var example = new Attachment("example", AttachmentArgs.builder()
            .autoscalingGroupName(exampleAwsAutoscalingGroup.id())
            .elb(exampleAwsElb.id())
            .build());

    }
}
Copy
resources:
  # Create a new load balancer attachment
  example:
    type: aws:autoscaling:Attachment
    properties:
      autoscalingGroupName: ${exampleAwsAutoscalingGroup.id}
      elb: ${exampleAwsElb.id}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

// Create a new ALB Target Group attachment
const example = new aws.autoscaling.Attachment("example", {
    autoscalingGroupName: exampleAwsAutoscalingGroup.id,
    lbTargetGroupArn: exampleAwsLbTargetGroup.arn,
});
Copy
import pulumi
import pulumi_aws as aws

# Create a new ALB Target Group attachment
example = aws.autoscaling.Attachment("example",
    autoscaling_group_name=example_aws_autoscaling_group["id"],
    lb_target_group_arn=example_aws_lb_target_group["arn"])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/autoscaling"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a new ALB Target Group attachment
		_, err := autoscaling.NewAttachment(ctx, "example", &autoscaling.AttachmentArgs{
			AutoscalingGroupName: pulumi.Any(exampleAwsAutoscalingGroup.Id),
			LbTargetGroupArn:     pulumi.Any(exampleAwsLbTargetGroup.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    // Create a new ALB Target Group attachment
    var example = new Aws.AutoScaling.Attachment("example", new()
    {
        AutoscalingGroupName = exampleAwsAutoscalingGroup.Id,
        LbTargetGroupArn = exampleAwsLbTargetGroup.Arn,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.autoscaling.Attachment;
import com.pulumi.aws.autoscaling.AttachmentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Create a new ALB Target Group attachment
        var example = new Attachment("example", AttachmentArgs.builder()
            .autoscalingGroupName(exampleAwsAutoscalingGroup.id())
            .lbTargetGroupArn(exampleAwsLbTargetGroup.arn())
            .build());

    }
}
Copy
resources:
  # Create a new ALB Target Group attachment
  example:
    type: aws:autoscaling:Attachment
    properties:
      autoscalingGroupName: ${exampleAwsAutoscalingGroup.id}
      lbTargetGroupArn: ${exampleAwsLbTargetGroup.arn}
Copy

Create Attachment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Attachment(name: string, args: AttachmentArgs, opts?: CustomResourceOptions);
@overload
def Attachment(resource_name: str,
               args: AttachmentArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Attachment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               autoscaling_group_name: Optional[str] = None,
               elb: Optional[str] = None,
               lb_target_group_arn: Optional[str] = None)
func NewAttachment(ctx *Context, name string, args AttachmentArgs, opts ...ResourceOption) (*Attachment, error)
public Attachment(string name, AttachmentArgs args, CustomResourceOptions? opts = null)
public Attachment(String name, AttachmentArgs args)
public Attachment(String name, AttachmentArgs args, CustomResourceOptions options)
type: aws:autoscaling:Attachment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AttachmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AttachmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AttachmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AttachmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AttachmentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var attachmentResource = new Aws.AutoScaling.Attachment("attachmentResource", new()
{
    AutoscalingGroupName = "string",
    Elb = "string",
    LbTargetGroupArn = "string",
});
Copy
example, err := autoscaling.NewAttachment(ctx, "attachmentResource", &autoscaling.AttachmentArgs{
	AutoscalingGroupName: pulumi.String("string"),
	Elb:                  pulumi.String("string"),
	LbTargetGroupArn:     pulumi.String("string"),
})
Copy
var attachmentResource = new com.pulumi.aws.autoscaling.Attachment("attachmentResource", com.pulumi.aws.autoscaling.AttachmentArgs.builder()
    .autoscalingGroupName("string")
    .elb("string")
    .lbTargetGroupArn("string")
    .build());
Copy
attachment_resource = aws.autoscaling.Attachment("attachmentResource",
    autoscaling_group_name="string",
    elb="string",
    lb_target_group_arn="string")
Copy
const attachmentResource = new aws.autoscaling.Attachment("attachmentResource", {
    autoscalingGroupName: "string",
    elb: "string",
    lbTargetGroupArn: "string",
});
Copy
type: aws:autoscaling:Attachment
properties:
    autoscalingGroupName: string
    elb: string
    lbTargetGroupArn: string
Copy

Attachment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Attachment resource accepts the following input properties:

AutoscalingGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of ASG to associate with the ELB.
Elb Changes to this property will trigger replacement. string
Name of the ELB.
LbTargetGroupArn Changes to this property will trigger replacement. string
ARN of a load balancer target group.
AutoscalingGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of ASG to associate with the ELB.
Elb Changes to this property will trigger replacement. string
Name of the ELB.
LbTargetGroupArn Changes to this property will trigger replacement. string
ARN of a load balancer target group.
autoscalingGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of ASG to associate with the ELB.
elb Changes to this property will trigger replacement. String
Name of the ELB.
lbTargetGroupArn Changes to this property will trigger replacement. String
ARN of a load balancer target group.
autoscalingGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of ASG to associate with the ELB.
elb Changes to this property will trigger replacement. string
Name of the ELB.
lbTargetGroupArn Changes to this property will trigger replacement. string
ARN of a load balancer target group.
autoscaling_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of ASG to associate with the ELB.
elb Changes to this property will trigger replacement. str
Name of the ELB.
lb_target_group_arn Changes to this property will trigger replacement. str
ARN of a load balancer target group.
autoscalingGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of ASG to associate with the ELB.
elb Changes to this property will trigger replacement. String
Name of the ELB.
lbTargetGroupArn Changes to this property will trigger replacement. String
ARN of a load balancer target group.

Outputs

All input properties are implicitly available as output properties. Additionally, the Attachment resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Attachment Resource

Get an existing Attachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AttachmentState, opts?: CustomResourceOptions): Attachment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        autoscaling_group_name: Optional[str] = None,
        elb: Optional[str] = None,
        lb_target_group_arn: Optional[str] = None) -> Attachment
func GetAttachment(ctx *Context, name string, id IDInput, state *AttachmentState, opts ...ResourceOption) (*Attachment, error)
public static Attachment Get(string name, Input<string> id, AttachmentState? state, CustomResourceOptions? opts = null)
public static Attachment get(String name, Output<String> id, AttachmentState state, CustomResourceOptions options)
resources:  _:    type: aws:autoscaling:Attachment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AutoscalingGroupName Changes to this property will trigger replacement. string
Name of ASG to associate with the ELB.
Elb Changes to this property will trigger replacement. string
Name of the ELB.
LbTargetGroupArn Changes to this property will trigger replacement. string
ARN of a load balancer target group.
AutoscalingGroupName Changes to this property will trigger replacement. string
Name of ASG to associate with the ELB.
Elb Changes to this property will trigger replacement. string
Name of the ELB.
LbTargetGroupArn Changes to this property will trigger replacement. string
ARN of a load balancer target group.
autoscalingGroupName Changes to this property will trigger replacement. String
Name of ASG to associate with the ELB.
elb Changes to this property will trigger replacement. String
Name of the ELB.
lbTargetGroupArn Changes to this property will trigger replacement. String
ARN of a load balancer target group.
autoscalingGroupName Changes to this property will trigger replacement. string
Name of ASG to associate with the ELB.
elb Changes to this property will trigger replacement. string
Name of the ELB.
lbTargetGroupArn Changes to this property will trigger replacement. string
ARN of a load balancer target group.
autoscaling_group_name Changes to this property will trigger replacement. str
Name of ASG to associate with the ELB.
elb Changes to this property will trigger replacement. str
Name of the ELB.
lb_target_group_arn Changes to this property will trigger replacement. str
ARN of a load balancer target group.
autoscalingGroupName Changes to this property will trigger replacement. String
Name of ASG to associate with the ELB.
elb Changes to this property will trigger replacement. String
Name of the ELB.
lbTargetGroupArn Changes to this property will trigger replacement. String
ARN of a load balancer target group.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.