Issue when using "route53.HostedZone.fromHostedZoneId" Method

[Cloudrage]

Reproduction Steps

When trying to import an HostedZone with :
route53.HostedZone.fromHostedZoneId(this, 'MyHostedZone', 'ID123456789')

Error Log

I've that error when launching the Stack :
HostedZone.fromHostedZoneId doesn't support "zoneName"

Environment

• CLI Version : CDK 1.42.1 (build a4797b4)
• Framework Version: 6.14.5
• Node.js Version: v12.15.0
• OS : Linux
• Language (Version): TypeScript

Other

So, I've imported that way :
route53.HostedZone.fromHostedZoneAttributes(this, 'R53Domain', {hostedZoneId: 'MyID123456789', zoneName: 'Toto'})

What's wrong with fromHostedZoneId Method ?

---

This is 🐛 Bug Report

[shivlaks]

What you're currently doing is fine. I do believe we can better document this as it has come up before as a point of confusion for users.

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.

fromHostedZoneAttributes will actually make a call to AWS to retrieve information and populate cdk.context.json.

It takes the attributes and performs an API call to determine which exact HostedZone is deployed and updates its behavior accordingly.

[Cloudrage]

Understood, thank you for the explanations !
Indeed, it can be detailed in the README and the error log maybe.

Definitely, I've gotten used to use fromXxXAttributes that gives better (real/exact) results.

About cdk.context.json, do you know any reasons why the file can't be populated anymore ?

[shivlaks]

About cdk.context.json, do you know any reasons why the file can't be populated anymore ?

can you expand on that? I need a little more information to dig into that. some questions that pop into my mind:

• was it being populated before but is not now?
• context lookups won't happen if the information it would look up already exists in cdk.context.json. are you observing behaviour different from that?

[Cloudrage]

Sorry, it's not our purpose but yes, it was polpulated before and not now.
I can say that the last time was the first time, when creating VPC resources ;D
I only have that on it :

{
  "@aws-cdk/core:enableStackNameDuplicates": "true",
  "aws-cdk:enableDiffNoFail": "true",
  "availability-zones:account=123456789:region=eu-west-1": [
    "eu-west-1a",
    "eu-west-1b",
    "eu-west-1c"
  ],
  "availability-zones:account=123456789:region=eu-west-1": [
    "eu-west-1a",
    "eu-west-1b",
    "eu-west-1c"
  ],
  "availability-zones:account=123456789:region=eu-west-1": [
    "eu-west-1a",
    "eu-west-1b",
    "eu-west-1c"
  ],
  "vpc-provider:account=123456789:filter.tag:Name=vpc-dev:region=eu-west-1:returnAsymmetricSubnets=true": {
    "vpcId": "vpc-123456789",
    "vpcCidrBlock": "1.2.3.4/23",
[...]

vpc-provider:account 3 times (for my 3 accounts); that's all.
Maybe I've to make a clear on it.

But, don't really nead that file, what is his main use ?

[shivlaks]

@Cloudrage sorry for the late reply i missed your question here. The primary purpose of the runtime context is to cache information from your AWS account (such as availability zones). This avoids unexpected changes to your deployments.

In your case, the context is populated so that the availability zones that are available and valid for the regions you are deploying are cached. If the cdk.context.json already exists, that lookup to populate the context will not be performed. We recommend that the project's context files be placed under version control along with the rest of your application for consistency when synthesizing and deploying templates.

you can learn more about runtime context here.

[shivlaks]

I'm resolving this issue as I don't believe further action is required.

Feel free to re-open / ask questions if anything has been left unanswered!

[Cloudrage]

Thanks @shivlaks for your time & explanations !