AWS CDK Reference

Appearance

v2.274.0

LoadBalancerTarget Class ​

Use an ELBv2 as an alias record target.

Source
aws-route53-targets/lib/load-balancer-target.ts
Type last changed
v2.173.0 · 12 Dec 2024

Example ​

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

declare const zone: route53.HostedZone;
declare const lb: elbv2.ApplicationLoadBalancer;

new route53.ARecord(this, 'AliasRecord', {
  zone,
  target: route53.RecordTarget.fromAlias(
    new targets.LoadBalancerTarget(lb, {
      evaluateTargetHealth: true,
    }),
  ),
});
python
import aws_cdk.aws_elasticloadbalancingv2 as elbv2

# zone: route53.HostedZone
# lb: elbv2.ApplicationLoadBalancer


route53.ARecord(self, "AliasRecord",
    zone=zone,
    target=route53.RecordTarget.from_alias(
        targets.LoadBalancerTarget(lb, {
            "evaluate_target_health": True
        }))
)
java
import software.amazon.awscdk.services.elasticloadbalancingv2.*;

HostedZone zone;
ApplicationLoadBalancer lb;


ARecord.Builder.create(this, "AliasRecord")
        .zone(zone)
        .target(RecordTarget.fromAlias(
        new LoadBalancerTarget(lb, Map.of(
                "evaluateTargetHealth", true))))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.ElasticLoadBalancingV2;

HostedZone zone;
ApplicationLoadBalancer lb;


new ARecord(this, "AliasRecord", new ARecordProps {
    Zone = zone,
    Target = RecordTarget.FromAlias(
    new LoadBalancerTarget(lb, new Dictionary<string, boolean?> {
        { "evaluateTargetHealth", true }
    }))
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import elbv2 "github.com/aws/aws-cdk-go/awscdk"

var zone HostedZone
var lb ApplicationLoadBalancer


route53.NewARecord(this, jsii.String("AliasRecord"), &ARecordProps{
	Zone: Zone,
	Target: route53.RecordTarget_FromAlias(
	targets.NewLoadBalancerTarget(lb, map[string]*bool{
		"evaluateTargetHealth": jsii.Boolean(true),
	})),
})

Initializer ​

ts
new LoadBalancerTarget(loadBalancer: ILoadBalancerV2, props?: IAliasRecordTargetProps)
python
LoadBalancerTarget(load_balancer: ILoadBalancerV2, props: typing.Optional[IAliasRecordTargetProps] = None)
java
new LoadBalancerTarget(ILoadBalancerV2 loadBalancer, IAliasRecordTargetProps props)
csharp
new LoadBalancerTarget(ILoadBalancerV2 loadBalancer, IAliasRecordTargetProps? props = null)
go
NewLoadBalancerTarget(LoadBalancer ILoadBalancerV2, Props IAliasRecordTargetProps)

Methods ​

bind(_record: IRecordSet, _zone?: IHostedZone): AliasRecordTargetConfigdef bind(self, _record: IRecordSet, _zone: typing.Optional[IHostedZone] = None) -> AliasRecordTargetConfigpublic AliasRecordTargetConfig bind(IRecordSet _record, IHostedZone _zone)public AliasRecordTargetConfig Bind(IRecordSet _record, IHostedZone? _zone = null)func Bind(_record IRecordSet, _zone IHostedZone) AliasRecordTargetConfig#
Return hosted zone ID and DNS name, usable for Route53 alias targets.