[Docs]: Example for security group rules show port ranges in a confusing manner

[TheJosh]

Documentation Link

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_security_group_ingress_rule

Description

The provided example values and also the ordering of the fields makes it look like a security group is some sort of mapping bit it isn't, instead it's a range of ports. In this case the example is for a very large 8000-port range, from port 80 all the way to port 8080. This would almost certainly not be what people would want, and in fact if it was used verbatim would be a security issue.

Suggestion would be to have both to_port and from_port be the same value, and change the field ordering so they're next to each other, e.g.

resource "aws_vpc_security_group_ingress_rule" "example" {
  security_group_id = aws_security_group.example.id

  cidr_ipv4   = "10.0.0.0/8"
  ip_protocol = "tcp"
  from_port   = 80
  to_port     = 80
}

If the desire is to show how a range of ports is supported, perhaps VNC could be used as an example, e.g.

resource "aws_vpc_security_group_ingress_rule" "vnc" {
  security_group_id = aws_security_group.example.id

  cidr_ipv4   = "10.0.0.0/8"
  ip_protocol = "tcp"
  from_port   = 5900
  to_port     = 5906
}

References

No response

Would you like to implement a fix?

None

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
• Please see our prioritization guide for information on how we prioritize.
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

Volunteering to Work on This Issue

• If you are interested in working on this issue, please leave a comment.
• If this would be your first contribution, please review the contribution guide.

[github-actions]

This functionality has been released in v5.6.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.