Route53: HostedZone.fromHostedZoneId() throws an error for cdk synth

• I’m submitting a …

  • 🪲 bug report
  • 🚀 feature request
  • 📚 construct library gap
  • ☎️ security issue or vulnerability => Please see policy
  • ❓ support request => Please see note at the top of this template.

• What is the current behavior? If the current behavior is a 🪲bug🪲: Please provide the steps to reproduce

Example code:

const domainZone = route53.HostedZone.fromHostedZoneId(this, 'domain-zone', hostedZoneId);

cdk synth throws an error:

HostedZone.fromHostedZoneId doesn't support "zoneName"

• What is the expected behavior (or behavior of feature suggested)?

fromHostedZoneId() should return a valid IHosted­Zone object.

• What is the motivation / use case for changing the behavior or adding this feature?

HostedZone is needed, for instance, for LoadBalancedFargateServiceProps (for the domainZone property).

• Please tell us about your environment:

  • CDK CLI Version: 1.4.0 (build 175471f)
  • Module Version: 1.4.0
  • OS: OSX Mojave
  • Language: TypeScript

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. associated pull-request, stackoverflow, gitter, etc)

[rhboyd]

@realharry for Hosted Zones there are 3 methods that accomplish very similar, but slightly different goals.

fromHostedZoneId(...) and fromHostedZoneName(...) will create a mock object with just the ZoneId or the ZoneName field present. These are useful if you need to supply a HostedZone object but you know that the resource that is accepting the HostedZone only needs access to one of those variables. This is done without having make an API call so it can be done entirely locally.

The third method is fromAttributes(...) that will take the attributes and perform an API call to determine which exact HostedZone is deployed and updates its behavior accordingly.

The first two methods create use different Classes of IHostedZone that throw an error if you use the wrong parameter (e.g. calling getName() when you used fromHostedZoneId())

[kevinjamescasey]

I just fell into the same trap two years after this problem was first reported. It would be nice if the docs were updated so everybody didn’t have to get the error, search for it on google, and read a bunch of threads to find the explanation of this wacky function.