security-group

This component provisions AWS Security Groups that can be shared across multiple components. It is a thin wrapper around the cloudposse/security-group/aws module that integrates with the Atmos stack configuration and remote state patterns.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component.

# catalog/security-group/defaults
components:
  terraform:
    security-group/defaults:
      metadata:
        type: abstract
        component: security-group
      vars:
        enabled: true
        allow_all_egress: true
        # Configure where account-map is deployed (required when account_map_enabled: true)
        account_map_tenant_name: core

# catalog/security-group/lambda
import:
  - catalog/security-group/defaults

components:
  terraform:
    security-group/lambda:
      metadata:
        inherits:
          - security-group/defaults
      vars:
        name: "lambda"
        security_group_description: "Security group for Lambda functions"
        rules:
          - type: "egress"
            from_port: 0
            to_port: 0
            protocol: "-1"
            cidr_blocks: ["0.0.0.0/0"]
            ipv6_cidr_blocks: ["::/0"]

# stacks/orgs/acme/plat/dev/us-east-2/network.yaml
import:
  - catalog/security-group/lambda

components:
  terraform:
    security-group/lambda:
      vars:
        enabled: true

Account Map Bypass Pattern

By default, this component uses the account-map component via remote state for IAM role lookups (account_map_enabled: true). For environments migrating to Atmos Auth or using static account mappings, you can disable this and provide a static account_map variable instead:

# stacks/orgs/acme/_defaults.yaml
vars:
  # Disable account-map remote state lookup
  account_map_enabled: false
  # Provide static account mapping
  account_map:
    full_account_map:
      acme-core-root: "111111111111"
      acme-core-audit: "222222222222"
      acme-plat-dev: "333333333333"
      acme-plat-prod: "444444444444"
    audit_account_account_name: "acme-core-audit"
    root_account_account_name: "acme-core-root"
    identity_account_account_name: "acme-core-identity"
    aws_partition: "aws"
    iam_role_arn_templates:
      terraform: "arn:aws:iam::%s:role/acme-core-gbl-auto-terraform"

When account_map_enabled: false, the component bypasses the remote state lookup and uses the static account_map variable directly.

Providing VPC ID Directly

You can provide the VPC ID directly via the vpc_id variable, which overrides the remote state lookup:

components:
  terraform:
    security-group/lambda:
      vars:
        # Provide VPC ID directly (overrides remote state lookup)
        vpc_id: "vpc-12345678"

This is useful when:

• The VPC was created outside of Atmos/Terraform
• You want to reference a VPC from a different state backend
• You're using Atmos functions like !terraform.output to fetch the VPC ID

Referencing the Security Group from Other Components

Once deployed, other components can reference this security group using the !terraform.state Atmos function:

components:
  terraform:
    lambda/my-function:
      vars:
        vpc_config:
          security_group_ids:
            - !terraform.state security-group/lambda security_group_id

Variables

Required Variables

region (string) required

AWS Region

Optional Variables

allow_all_egress (bool) optional

A convenience that adds to the rules specified elsewhere a rule that allows all egress.
If this is false and no egress rules are specified via rules or rule-matrix, then no egress will be allowed.

Default value: true

create_before_destroy (bool) optional

Set true to enable terraform create_before_destroy behavior on the created security group.
We only recommend setting this false if you are importing an existing security group
that you do not want replaced and therefore need full control over its name.
Note that changing this value will always cause the security group to be replaced.

Default value: true

inline_rules_enabled (bool) optional

NOT RECOMMENDED. Create rules "inline" instead of as separate aws_security_group_rule resources.
See the cloudposse/security-group/aws module documentation for caveats.

Default value: false

preserve_security_group_id (bool) optional

When false and create_before_destroy is true, changes to security group rules
cause a new security group to be created with the new rules, and the existing security group is then
replaced with the new one, eliminating any service interruption.
When true or when changing the value (from false to true or from true to false),
existing security group rules will be deleted before new ones are created, resulting in a service interruption,
but preserving the security group itself.
NOTE: Setting this to true does not guarantee the security group will never be replaced,
it only keeps changes to the security group rules from triggering a replacement.

Default value: false

revoke_rules_on_delete (bool) optional

Instruct Terraform to revoke all of the Security Group's attached ingress and egress rules before deleting
the Security Group itself. This is normally not needed, however certain AWS services such as
Elastic Map Reduce may automatically add required rules to security groups used with the service,
and those rules may contain a cyclic dependency that prevent the security groups from being destroyed.

Default value: false

rule_matrix (any) optional

A convenient way to apply the same set of rules to a set of subjects. See the cloudposse/security-group/aws module documentation for details.

Default value: [ ]

rules (list(any)) optional

A list of Security Group rule objects. All elements of a list must be exactly the same type;
use rules_map if you want to supply multiple lists of rules.
Rules are defined in a map of rule objects. See the cloudposse/security-group/aws module documentation for details.

Default value: [ ]

rules_map (any) optional

A map-like object of lists of Security Group rule objects. See the cloudposse/security-group/aws module documentation for details.

Default value: { }

security_group_description (string) optional

The description to assign to the created Security Group.
Warning: Changing the description causes the security group to be replaced.

Default value: "Managed by Terraform"

security_group_name (list(string)) optional

The name to assign to the created security group. Must be unique within the VPC.
If not provided, will be derived from the null-label context.

Default value: [ ]

target_security_group_id (list(string)) optional

The ID of an existing Security Group to which Security Group rules will be assigned.
The Security Group's name and description will not be changed.
Not compatible with inline_rules_enabled or revoke_rules_on_delete.
If not provided, a new security group will be created.

Default value: [ ]

vpc_component_name (string) optional

The name of the VPC component to fetch remote state from

Default value: "vpc"

vpc_environment_name (string) optional

The name of the environment where the VPC component is provisioned. Defaults to the current environment.

Default value: null

vpc_id (string) optional

The ID of the VPC where the Security Group will be created.
If provided, this overrides the VPC ID from remote state lookup.

Default value: null

vpc_stage_name (string) optional

The name of the stage where the VPC component is provisioned. Defaults to the current stage.

Default value: null

vpc_tenant_name (string) optional

The name of the tenant where the VPC component is provisioned.
Defaults to the current tenant.

Default value: null

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.

Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.

Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.

Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.

Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

arn

The ARN of the created Security Group

id

The ID of the created Security Group

name

The name of the created Security Group

rules_terraform_ids

List of Terraform IDs of created security_group_rule resources, primarily provided to enable depends_on

security_group_arn

The ARN of the created Security Group (alias for arn output)

security_group_id

The ID of the created Security Group (alias for id output)

security_group_name

The name of the created Security Group (alias for name output)

Dependencies

Requirements

• terraform, version: >= 1.0.0
• aws, version: >= 4.9.0, < 6.0.0

Modules

Name	Version	Source	Description
iam_roles	latest	../account-map/modules/iam-roles	n/a
security_group	2.2.0	cloudposse/security-group/aws	n/a
this	0.25.0	cloudposse/label/null	n/a
vpc	1.8.0	cloudposse/stack-config/yaml//modules/remote-state	n/a