AWS CDK Reference

Appearance

v2.274.0

ApiGatewayv2DomainProperties Class ​

Defines an API Gateway V2 domain name as the alias target.

Source
aws-route53-targets/lib/api-gatewayv2-domain-name.ts

Example ​

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

declare const zone: route53.HostedZone;
declare const domainName: apigwv2.DomainName;

new route53.ARecord(this, 'AliasRecord', {
  zone,
  target: route53.RecordTarget.fromAlias(new targets.ApiGatewayv2DomainProperties(domainName.regionalDomainName, domainName.regionalHostedZoneId)),
});
python
import aws_cdk.aws_apigatewayv2 as apigwv2

# zone: route53.HostedZone
# domain_name: apigwv2.DomainName


route53.ARecord(self, "AliasRecord",
    zone=zone,
    target=route53.RecordTarget.from_alias(targets.ApiGatewayv2DomainProperties(domain_name.regional_domain_name, domain_name.regional_hosted_zone_id))
)
java
import software.amazon.awscdk.services.apigatewayv2.*;

HostedZone zone;
DomainName domainName;


ARecord.Builder.create(this, "AliasRecord")
        .zone(zone)
        .target(RecordTarget.fromAlias(new ApiGatewayv2DomainProperties(domainName.getRegionalDomainName(), domainName.getRegionalHostedZoneId())))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.Apigatewayv2;

HostedZone zone;
DomainName domainName;


new ARecord(this, "AliasRecord", new ARecordProps {
    Zone = zone,
    Target = RecordTarget.FromAlias(new ApiGatewayv2DomainProperties(domainName.RegionalDomainName, domainName.RegionalHostedZoneId))
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import apigwv2 "github.com/aws/aws-cdk-go/awscdk"

var zone HostedZone
var domainName DomainName


route53.NewARecord(this, jsii.String("AliasRecord"), &ARecordProps{
	Zone: Zone,
	Target: route53.RecordTarget_FromAlias(targets.NewApiGatewayv2DomainProperties(domainName.regionalDomainName, domainName.regionalHostedZoneId)),
})

Initializer ​

ts
new ApiGatewayv2DomainProperties(regionalDomainName: string, regionalHostedZoneId: string)
python
ApiGatewayv2DomainProperties(regional_domain_name: str, regional_hosted_zone_id: str)
java
new ApiGatewayv2DomainProperties(String regionalDomainName, String regionalHostedZoneId)
csharp
new ApiGatewayv2DomainProperties(string regionalDomainName, string regionalHostedZoneId)
go
NewApiGatewayv2DomainProperties(RegionalDomainName *string, RegionalHostedZoneId *string)

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.