aws-cdk-lib.aws_route53_targets.ApiGatewayv2DomainProperties

class ApiGatewayv2DomainProperties

LanguageType name
.NETAmazon.CDK.AWS.Route53.Targets.ApiGatewayv2DomainProperties
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsroute53targets#ApiGatewayv2DomainProperties
Javasoftware.amazon.awscdk.services.route53.targets.ApiGatewayv2DomainProperties
Pythonaws_cdk.aws_route53_targets.ApiGatewayv2DomainProperties
TypeScript (source)aws-cdk-lib » aws_route53_targets » ApiGatewayv2DomainProperties

Implements IAliasRecordTarget

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

Example

import * as apigwv2 from '@aws-cdk/aws-apigatewayv2-alpha';

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)),
});

Initializer

new ApiGatewayv2DomainProperties(regionalDomainName: string, regionalHostedZoneId: string)

Parameters

  • regionalDomainName string — the domain name associated with the regional endpoint for this custom domain name.
  • regionalHostedZoneId string — the region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.

Methods

NameDescription
bind(_record, _zone?)Return hosted zone ID and DNS name, usable for Route53 alias targets.

bind(_record, _zone?)

public bind(_record: IRecordSet, _zone?: IHostedZone): AliasRecordTargetConfig

Parameters

  • _record IRecordSet
  • _zone IHostedZone

Returns

  • AliasRecordTargetConfig

Return hosted zone ID and DNS name, usable for Route53 alias targets.