Skip to content
v2.275.0

LambdaTarget Class ​

Example ​

ts
import * as lambda from 'aws-cdk-lib/aws-lambda';
import * as targets from 'aws-cdk-lib/aws-elasticloadbalancingv2-targets';

declare const lambdaFunction: lambda.Function;
declare const lb: elbv2.ApplicationLoadBalancer;

const listener = lb.addListener('Listener', { port: 80 });
listener.addTargets('Targets', {
  targets: [new targets.LambdaTarget(lambdaFunction)],

  // For Lambda Targets, you need to explicitly enable health checks if you
  // want them.
  healthCheck: {
    enabled: true,
  }
});
python
import aws_cdk.aws_lambda as lambda_
import aws_cdk.aws_elasticloadbalancingv2_targets as targets

# lambda_function: lambda.Function
# lb: elbv2.ApplicationLoadBalancer


listener = lb.add_listener("Listener", port=80)
listener.add_targets("Targets",
    targets=[targets.LambdaTarget(lambda_function)],

    # For Lambda Targets, you need to explicitly enable health checks if you
    # want them.
    health_check=elbv2.HealthCheck(
        enabled=True
    )
)
java
import software.amazon.awscdk.services.lambda.*;
import software.amazon.awscdk.services.elasticloadbalancingv2.targets.*;

Function lambdaFunction;
ApplicationLoadBalancer lb;


ApplicationListener listener = lb.addListener("Listener", BaseApplicationListenerProps.builder().port(80).build());
listener.addTargets("Targets", AddApplicationTargetsProps.builder()
        .targets(List.of(new LambdaTarget(lambdaFunction)))

        // For Lambda Targets, you need to explicitly enable health checks if you
        // want them.
        .healthCheck(HealthCheck.builder()
                .enabled(true)
                .build())
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.Lambda;
using Amazon.CDK.AWS.ElasticLoadBalancingV2.Targets;

Function lambdaFunction;
ApplicationLoadBalancer lb;


var listener = lb.AddListener("Listener", new BaseApplicationListenerProps { Port = 80 });
listener.AddTargets("Targets", new AddApplicationTargetsProps {
    Targets = new [] { new LambdaTarget(lambdaFunction) },

    // For Lambda Targets, you need to explicitly enable health checks if you
    // want them.
    HealthCheck = new HealthCheck {
        Enabled = true
    }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import lambda "github.com/aws/aws-cdk-go/awscdk"
import targets "github.com/aws/aws-cdk-go/awscdk"

var lambdaFunction Function
var lb ApplicationLoadBalancer


listener := lb.AddListener(jsii.String("Listener"), &BaseApplicationListenerProps{
	Port: jsii.Number(80),
})
listener.AddTargets(jsii.String("Targets"), &AddApplicationTargetsProps{
	Targets: []IApplicationLoadBalancerTarget{
		targets.NewLambdaTarget(lambdaFunction),
	},

	// For Lambda Targets, you need to explicitly enable health checks if you
	// want them.
	HealthCheck: &HealthCheck{
		Enabled: jsii.Boolean(true),
	},
})

Initializer ​

ts
new LambdaTarget(fn: IFunction)
python
LambdaTarget(fn: IFunction)
java
new LambdaTarget(IFunction fn)
csharp
new LambdaTarget(IFunction fn)
go
NewLambdaTarget(Fn IFunction)

Methods ​

attachToApplicationTargetGroup(targetGroup: IApplicationTargetGroup): LoadBalancerTargetPropsdef attach_to_application_target_group(self, target_group: IApplicationTargetGroup) -> LoadBalancerTargetPropspublic LoadBalancerTargetProps attachToApplicationTargetGroup(IApplicationTargetGroup targetGroup)public LoadBalancerTargetProps AttachToApplicationTargetGroup(IApplicationTargetGroup targetGroup)func AttachToApplicationTargetGroup(TargetGroup IApplicationTargetGroup) LoadBalancerTargetProps#
Register this instance target with a load balancer.

Don't call this, it is called automatically when you add the target to a load balancer.

attachToNetworkTargetGroup(targetGroup: INetworkTargetGroup): LoadBalancerTargetPropsdef attach_to_network_target_group(self, target_group: INetworkTargetGroup) -> LoadBalancerTargetPropspublic LoadBalancerTargetProps attachToNetworkTargetGroup(INetworkTargetGroup targetGroup)public LoadBalancerTargetProps AttachToNetworkTargetGroup(INetworkTargetGroup targetGroup)func AttachToNetworkTargetGroup(TargetGroup INetworkTargetGroup) LoadBalancerTargetProps#
Register this instance target with a load balancer.

Don't call this, it is called automatically when you add the target to a load balancer.