Skip to content

Files

Latest commit

 

History

History
51 lines (36 loc) · 1.58 KB

aws-vpc-add-description-to-security-group-rule.md

File metadata and controls

51 lines (36 loc) · 1.58 KB

Pattern: Missing description for AWS security group rule

Issue: -

Description

Security group rules should include a description for auditing purposes. This simplifies auditing, debugging, and managing security groups.

Resolution: Add descriptions for all security groups rules.

Examples

The following example will fail the aws-vpc-add-description-to-security-group-rule check.

 resource "aws_security_group" "bad_example" {
   name        = "http"
 
   ingress {
     from_port   = 80
     to_port     = 80
     protocol    = "tcp"
     cidr_blocks = [aws_vpc.main.cidr_block]
   }
 }
 

The following example will pass the aws-vpc-add-description-to-security-group-rule check.

 resource "aws_security_group" "good_example" {
   name        = "http"
   description = "Allow inbound HTTP traffic"
 
   ingress {
     description = "HTTP from VPC"
     from_port   = 80
     to_port     = 80
     protocol    = "tcp"
     cidr_blocks = [aws_vpc.main.cidr_block]
   }
 }
 

Further reading