Skip to content
v2.274.0

GlobalAcceleratorTarget Class ​

Use a Global Accelerator instance domain name as an alias record target.

Example ​

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

declare const zone: route53.HostedZone;
declare const accelerator: globalaccelerator.Accelerator;

new route53.ARecord(this, 'AliasRecord', {
  zone,
  target: route53.RecordTarget.fromAlias(
    new targets.GlobalAcceleratorTarget(accelerator, {
      evaluateTargetHealth: true,
    }),
  ),
  // or
  // route53.RecordTarget.fromAlias(new targets.GlobalAcceleratorDomainTarget('xyz.awsglobalaccelerator.com',{
  //   evaluateTargetHealth: true,
  // })),
});
python
import aws_cdk.aws_globalaccelerator as globalaccelerator

# zone: route53.HostedZone
# accelerator: globalaccelerator.Accelerator


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

HostedZone zone;
Accelerator accelerator;


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

HostedZone zone;
Accelerator accelerator;


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

var zone HostedZone
var accelerator Accelerator


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

Initializer ​

ts
new GlobalAcceleratorTarget(accelerator: IAcceleratorRef, props?: IAliasRecordTargetProps)
python
GlobalAcceleratorTarget(accelerator: IAcceleratorRef, props: typing.Optional[IAliasRecordTargetProps] = None)
java
new GlobalAcceleratorTarget(IAcceleratorRef accelerator, IAliasRecordTargetProps props)
csharp
new GlobalAcceleratorTarget(IAcceleratorRef accelerator, IAliasRecordTargetProps? props = null)
go
NewGlobalAcceleratorTarget(Accelerator IAcceleratorRef, Props IAliasRecordTargetProps)

Properties ​

GLOBAL_ACCELERATOR_ZONE_IDstringglobal_accelerator_zone_idstrGLOBAL_ACCELERATOR_ZONE_IDStringGLOBAL_ACCELERATOR_ZONE_IDstringGLOBAL_ACCELERATOR_ZONE_ID*stringrequiredstatic#
The hosted zone Id if using an alias record in Route53.

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.