Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(ec2.CfnNetworkAclEntry): Invalid links to CloudFormation documentation #27171

Open
hikarunakatani opened this issue Sep 17, 2023 · 2 comments
Open
Labels
@aws-cdk/aws-ec2 Related to Amazon Elastic Compute Cloud @aws-cdk/cfnspec bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2

Comments

@hikarunakatani
Copy link

Describe the issue

The CloudFormation documentation links embedded in the ec2.CfnNetworkAclEntry seem to be invalid and redirect to user guide page of Cloudformation.

class CfnNetworkAclEntry (construct) · AWS CDK
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.CfnNetworkAclEntry.html

Example link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-networkaclid

The correct link should be like this:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-networkaclid

Links

class CfnNetworkAclEntry (construct) · AWS CDK
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.CfnNetworkAclEntry.html

@hikarunakatani hikarunakatani added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Sep 17, 2023
@github-actions github-actions bot added the @aws-cdk/aws-ec2 Related to Amazon Elastic Compute Cloud label Sep 17, 2023
@khushail
Copy link
Contributor

Hi @hikarunakatani , thanks for reaching out. Yes, this should be corrected.

@khushail khushail added p2 effort/small Small work item – less than a day of effort needs-cfn This issue is waiting on changes to CloudFormation before it can be addressed. and removed needs-triage This issue or PR still needs to be triaged. labels Sep 18, 2023
@peterwoodworth
Copy link
Contributor

The correct URL has been in the spec source for a while now. So, this seems to be on our end

"Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html",

It seems to be an issue with cfnspec rather than just the docs. You can see the same incorrect docs link in the generated type file

export declare namespace CfnNetworkAclEntry {
    /**
     * Describes a range of ports.
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html
     */

I'm not sure where this is handled. Since the link that it displays used to be what was in the CfnSpec, I suspect it failed to update for some reason.

@peterwoodworth peterwoodworth added @aws-cdk/cfnspec bug This issue is a bug. and removed needs-cfn This issue is waiting on changes to CloudFormation before it can be addressed. labels Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-ec2 Related to Amazon Elastic Compute Cloud @aws-cdk/cfnspec bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2
Projects
None yet
Development

No branches or pull requests

3 participants