cdk-route53-apigateway-alias

Implement a CfnRecordSet workaround for Route53 alias targets in CDK v2.

2|Updated May 10, 2026
One-click install
npx skills add https://github.com/freedomw1987/tree_monstor --skill cdk-route53-apigateway-alias
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cdk-route53-apigateway-alias
Source: https://github.com/freedomw1987/tree_monstor/tree/main/skills/devops/cdk-route53-apigateway-alias
Command: npx skills add https://github.com/freedomw1987/tree_monstor --skill cdk-route53-apigateway-alias

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

CDK v2 throws a TypeError when attempting to create a Route53 ARecord alias target for an API Gateway custom domain, as the aws_apigateway.DomainName construct lacks the required bind() method from the IAliasRecordTarget interface, breaking infrastructure as code deployments for this common AWS pattern.

Core Features & Use Cases

  • Tested Workaround Implementation: Provides a working low-level CfnRecordSet construct that replaces the broken high-level ARecord to create valid alias DNS records for API Gateway custom domains.
  • Compatibility Guidance: Includes notes on known CDK v2 version compatibility issues with alias targets and recommended stable library versions to avoid related errors.
  • Use Case: Developers building AWS serverless applications with API Gateway custom domains and Route53 DNS in CDK v2 can use this skill to resolve the binding error and successfully deploy their infrastructure.

Quick Start

Use this skill to implement a working Route53 A alias record for your CDK v2 API Gateway custom domain to resolve the bind() method deployment error.

Frequently Asked Questions about cdk-route53-apigateway-alias

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
Why does CDK v2 throw a TypeError when creating a Route53 ARecord alias for an API Gateway custom domain?

CDK v2 throws this TypeError because the aws_apigateway.DomainName construct lacks the required bind() method from the IAliasRecordTarget interface, breaking the Route53 ARecord alias creation for API Gateway custom domains.

How do I create a Route53 alias record for an API Gateway custom domain in CDK v2?

You can create a Route53 alias record for an API Gateway custom domain in CDK v2 by using a low-level CfnRecordSet construct as a workaround, which successfully replaces the broken high-level ARecord construct to deploy valid DNS alias records.

Can I use the standard ARecord construct with API Gateway custom domains in CDK v2?

You cannot use the standard high-level ARecord construct with API Gateway custom domains in CDK v2 because the DomainName construct fails to implement the required IAliasRecordTarget bind() method, causing deployment failures.

Which CDK v2 versions are compatible with Route53 API Gateway alias targets?

Specific CDK v2 library versions have known compatibility issues with Route53 API Gateway alias targets, and this Skill provides guidance on recommended stable library versions to avoid related deployment errors.

What is the best workaround for the missing bind() method on the API Gateway DomainName construct in CDK v2?

The best workaround for the missing bind() method on the API Gateway DomainName construct in CDK v2 is implementing a tested low-level CfnRecordSet construct that directly creates valid alias DNS records for regional API Gateway custom domains.

Do I need to use CfnRecordSet instead of ARecord to fix the Route53 API Gateway alias error in CDK v2?

Yes, you need to use the low-level CfnRecordSet construct instead of the high-level ARecord to fix the Route53 API Gateway alias error in CDK v2, because it successfully bypasses the missing IAliasRecordTarget bind() method issue.