security-group | Patterned Designs Documentation

Overview

The security-group module creates and manages AWS security groups with production-ready defaults including:

Flexible ingress and egress rule configuration
CIDR block and security group source references
Self-referencing rules for cluster communication
Managed prefix list support
Stateful connection tracking

Category: Networking Provider: AWS Latest Version: 1.2.0

Quick Start

module "web_sg" {
  source  = "registry.patterneddesigns.ca/patterneddesigns/security-group/aws"
  version = "1.2.0"

  name   = "web-server"
  vpc_id = module.vpc.vpc_id

  ingress_rules = [
    {
      from_port   = 443
      to_port     = 443
      protocol    = "tcp"
      cidr_blocks = ["0.0.0.0/0"]
    }
  ]

  egress_rules = [
    {
      from_port   = 0
      to_port     = 0
      protocol    = "-1"
      cidr_blocks = ["0.0.0.0/0"]
    }
  ]
}

Key Features

Rule Management

Define ingress and egress rules with flexible source/destination options:

module "app_sg" {
  source  = "registry.patterneddesigns.ca/patterneddesigns/security-group/aws"
  version = "1.2.0"

  name   = "application-server"
  vpc_id = module.vpc.vpc_id

  ingress_rules = [
    {
      from_port       = 8080
      to_port         = 8080
      protocol        = "tcp"
      security_groups = [module.web_sg.security_group_id]
    }
  ]
}

Prefix List Support

Reference AWS managed prefix lists for dynamic CIDR management:

module "restricted_sg" {
  source  = "registry.patterneddesigns.ca/patterneddesigns/security-group/aws"
  version = "1.2.0"

  name   = "corporate-access"
  vpc_id = module.vpc.vpc_id

  ingress_rules = [
    {
      from_port       = 22
      to_port         = 22
      protocol        = "tcp"
      prefix_list_ids = [data.aws_ec2_managed_prefix_list.corporate.id]
    }
  ]
}

Security Group References

Chain security groups for layered access control:

module "db_sg" {
  source  = "registry.patterneddesigns.ca/patterneddesigns/security-group/aws"
  version = "1.2.0"

  name   = "database"
  vpc_id = module.vpc.vpc_id

  ingress_rules = [
    {
      from_port       = 5432
      to_port         = 5432
      protocol        = "tcp"
      security_groups = [module.app_sg.security_group_id]
    }
  ]
}

Documentation

Inputs - All input parameters
Outputs - Output values
Examples - Usage examples
Use Cases - Common scenarios
Demonstrations - Step-by-step guides

Registry

View specification on Registry

Inputs

name Required

string

Name of the security group

vpc_id Required

string

VPC ID where the security group will be created

ingress_rules

list(object({ from_port = number to_port = number protocol = string cidr_blocks = optional(list(string), []) description = optional(string, "") }))

List of ingress rules

egress_rules

list(object({ from_port = number to_port = number protocol = string cidr_blocks = optional(list(string), []) description = optional(string, "") })) Default:

[
{
from_port = 0
to_port = 0
protocol = "-1"
cidr_blocks = ["0.0.0.0/0"]

List of egress rules