Skip to content

cloudposse-terraform-components/aws-security-hub

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

47 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Project Banner

Latest ReleaseSlack CommunityGet Support

This component is responsible for configuring Security Hub within an AWS Organization.

Amazon Security Hub enables users to centrally manage and monitor the security and compliance of their AWS accounts and resources. It aggregates, organizes, and prioritizes security findings from various AWS services, third-party tools, and integrated partner solutions.

Key Features

  • Centralized Security Management: Provides a centralized dashboard where users can view and manage security findings from multiple AWS accounts and regions, allowing for a unified view of the security posture across the entire AWS environment.

  • Automated Security Checks: Automatically performs continuous security checks on AWS resources, configurations, and security best practices using industry standards and compliance frameworks such as AWS CIS Foundations Benchmark.

  • Product Subscriptions: Integrates with AWS security services (GuardDuty, Inspector, Macie, Config, Access Analyzer, Firewall Manager) to automatically receive and aggregate findings in a single dashboard.

  • Security Standards and Compliance: Provides compliance checks against industry standards and regulatory frameworks such as PCI DSS, HIPAA, NIST 800-53, and GDPR, with guidance on remediation actions.

  • Prioritized Security Findings: Analyzes and prioritizes security findings based on severity, enabling users to focus on the most critical issues with efficient threat response and remediation.

  • Custom Insights and Event Aggregation: Supports custom insights and rules to focus on specific security criteria, with event aggregation and correlation capabilities to identify related findings and attack patterns.

  • Alert Notifications and Automation: Supports alert notifications through Amazon SNS and facilitates automation through integration with AWS Lambda for automated remediation actions.

  • GovCloud Support: All product subscription ARNs use partition-aware format, automatically supporting both Commercial AWS and GovCloud partitions.

Component Features

  • Delegated Administrator Model: Uses AWS Organizations delegated administrator pattern for centralized management
  • Multi-Region Deployment: Supports deployment across all AWS regions with finding aggregation
  • Product Subscriptions: Automatically creates subscriptions for AWS security service integrations
  • SNS Notifications: Optional SNS topic creation for security finding alerts
  • Compliance Standards: Configurable security standards (CIS, PCI DSS, AWS Foundational Security Best Practices)

Tip

πŸ‘½ Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform
Example of running atmos to manage infrastructure from our Quick Start tutorial.

Usage

Stack Level: Regional

Deployment Overview

This component is complex in that it must be deployed multiple times with different variables set to configure the AWS Organization successfully.

It is further complicated by the fact that you must deploy each of the component instances described below to every region that existed before March 2019 and to any regions that have been opted-in as described in the AWS Documentation.

In the examples below, we assume that the AWS Organization Management account is root and the AWS Organization Delegated Administrator account is security, both in the core tenant.

Deploy to Delegated Administrator Account

First, the component is deployed to the Delegated Administrator account in each region to configure the Security Hub instance to which each account will send its findings.

# core-ue1-security
components:
  terraform:
    security-hub/delegated-administrator/ue1:
      metadata:
        component: security-hub
      vars:
        enabled: true
        delegated_administrator_account_name: core-security
        environment: ue1
        region: us-east-1
        # Product subscriptions for AWS security service integrations
        product_subscriptions:
          guardduty: true        # Enable GuardDuty findings
          inspector: true        # Enable Inspector findings
          macie: true            # Enable Macie findings
          config: true           # Enable Config findings
          access_analyzer: true  # Enable Access Analyzer findings
          firewall_manager: false # Disabled by default
atmos terraform apply security-hub/delegated-administrator/ue1 -s core-ue1-security
atmos terraform apply security-hub/delegated-administrator/ue2 -s core-ue2-security
atmos terraform apply security-hub/delegated-administrator/uw1 -s core-uw1-security
# ... other regions

Deploy to Organization Management (root) Account

Next, the component is deployed to the AWS Organization Management (a/k/a root) Account in order to set the AWS Organization Designated Administrator account.

Note that SuperAdmin permissions must be used as we are deploying to the AWS Organization Management account. Since we are using the SuperAdmin user, it will already have access to the state bucket, so we set the role_arn of the backend config to null and set var.privileged to true.

# core-ue1-root
components:
  terraform:
    security-hub/root/ue1:
      metadata:
        component: security-hub
      backend:
        s3:
          role_arn: null
      vars:
        enabled: true
        delegated_administrator_account_name: core-security
        environment: ue1
        region: us-east-1
        privileged: true
atmos terraform apply security-hub/root/ue1 -s core-ue1-root
atmos terraform apply security-hub/root/ue2 -s core-ue2-root
atmos terraform apply security-hub/root/uw1 -s core-uw1-root
# ... other regions

Deploy Organization Settings in Delegated Administrator Account

Finally, the component is deployed to the Delegated Administrator Account again in order to create the organization-wide Security Hub configuration for the AWS Organization, but with var.admin_delegated set to true this time to indicate that the delegation from the Organization Management account has already been performed.

# core-ue1-security
components:
  terraform:
    security-hub/org-settings/ue1:
      metadata:
        component: security-hub
      vars:
        enabled: true
        delegated_administrator_account_name: core-security
        environment: ue1
        region: us-east-1
        admin_delegated: true
atmos terraform apply security-hub/org-settings/ue1 -s core-ue1-security
atmos terraform apply security-hub/org-settings/ue2 -s core-ue2-security
atmos terraform apply security-hub/org-settings/uw1 -s core-uw1-security
# ... other regions

Product Subscriptions

Product subscriptions enable Security Hub to receive and aggregate findings from AWS security services. The component supports automatic integration with:

Product Default Description
GuardDuty true Threat detection findings
Inspector true Vulnerability scanning findings
Macie true Sensitive data discovery findings
Config true Configuration compliance findings
Access Analyzer true External access findings
Firewall Manager false Firewall policy compliance findings

Product subscriptions are only created during Step 1 (delegated administrator deployment) and use partition-aware ARN format for GovCloud compatibility.

Verification

After deployment, verify product subscriptions:

# Via Terraform output
atmos terraform output security-hub/delegated-administrator/ue1 -s core-ue1-security

# Via AWS CLI
aws securityhub list-enabled-products-for-import --region us-east-1

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Requirements

Name Version
terraform >= 1.0.0
aws >= 5.0, < 6.0.0
awsutils >= 0.16.0, < 6.0.0

Providers

Name Version
aws >= 5.0, < 6.0.0
awsutils >= 0.16.0, < 6.0.0

Modules

Name Source Version
account_map cloudposse/stack-config/yaml//modules/remote-state 1.8.0
iam_roles ../account-map/modules/iam-roles n/a
security_hub cloudposse/security-hub/aws 0.12.2
this cloudposse/label/null 0.25.0

Resources

Name Type
aws_securityhub_account.this resource
aws_securityhub_organization_admin_account.this resource
aws_securityhub_organization_configuration.this resource
aws_securityhub_product_subscription.this resource
awsutils_security_hub_organization_settings.this resource
aws_caller_identity.this data source
aws_partition.this data source
aws_region.this data source

Inputs

Name Description Type Default Required
account_map_component_name The name of the account-map component string "account-map" no
account_map_tenant The tenant where the account_map component required by remote-state is deployed string "core" no
additional_tag_map 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.
map(string) {} no
admin_delegated A flag to indicate if the AWS Organization-wide settings should be created. This can only be done after the Security
Hub Administrator account has already been delegated from the AWS Org Management account (usually 'root'). See the
Deployment section of the README for more information.
bool false no
attributes 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.
list(string) [] no
auto_enable_organization_members Flag to toggle auto-enablement of Security Hub for new member accounts in the organization.

For more information, see:
https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/securityhub_organization_configuration#auto_enable
bool true no
cloudwatch_event_rule_pattern_detail_type The detail-type pattern used to match events that will be sent to SNS.

For more information, see:
https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html
https://docs.aws.amazon.com/eventbridge/latest/userguide/event-types.html
string "Security Hub Findings - Imported" no
context 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.
any
{
"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
}
no
create_sns_topic Flag to indicate whether an SNS topic should be created for notifications. If you want to send findings to a new SNS
topic, set this to true and provide a valid configuration for subscribers.
bool false no
default_standards_enabled Flag to indicate whether default standards should be enabled bool true no
delegated_administrator_account_name The name of the account that is the AWS Organization Delegated Administrator account string "core-security" no
delimiter Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
string null no
descriptor_formats 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).
any {} no
enabled Set to false to prevent the module from creating any resources bool null no
enabled_standards A list of standards to enable in the account.

For example:
- standards/aws-foundational-security-best-practices/v/1.0.0
- ruleset/cis-aws-foundations-benchmark/v/1.2.0
- standards/pci-dss/v/3.2.1
- standards/cis-aws-foundations-benchmark/v/1.4.0
set(string) [] no
environment ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' string null no
finding_aggregation_region If finding aggregation is enabled, the region that collects findings string null no
finding_aggregator_enabled Flag to indicate whether a finding aggregator should be created

If you want to aggregate findings from one region, set this to true.

For more information, see:
https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/securityhub_finding_aggregator
bool false no
finding_aggregator_linking_mode Linking mode to use for the finding aggregator.

The possible values are:
- ALL_REGIONS - Aggregate from all regions
- ALL_REGIONS_EXCEPT_SPECIFIED - Aggregate from all regions except those specified in var.finding_aggregator_regions
- SPECIFIED_REGIONS - Aggregate from regions specified in var.finding_aggregator_regions
string "ALL_REGIONS" no
finding_aggregator_regions A list of regions to aggregate findings from.

This is only used if finding_aggregator_enabled is true.
any null no
findings_notification_arn The ARN for an SNS topic to send findings notifications to. This is only used if create_sns_topic is false.
If you want to send findings to an existing SNS topic, set this to the ARN of the existing topic and set
create_sns_topic to false.
string null no
global_environment Global environment name string "gbl" no
id_length_limit 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.
number null no
import_profile_name AWS Profile name to use when importing a resource string null no
import_role_arn IAM Role ARN to use when importing a resource string null no
label_key_case 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.
string null no
label_order 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.
list(string) null no
label_value_case 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.
string null no
labels_as_tags 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.
set(string)
[
"default"
]
no
name 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.
string null no
namespace ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique string null no
organization_management_account_name The name of the AWS Organization management account string null no
privileged true if the default provider already has access to the backend bool false no
product_subscriptions Map of AWS service product subscriptions to enable in Security Hub.
Product subscriptions allow Security Hub to receive findings from AWS security services.

Default values:
- guardduty: true (enable GuardDuty findings integration)
- inspector: true (enable Inspector findings integration)
- macie: true (enable Macie findings integration)
- config: true (enable Config findings integration)
- access_analyzer: true (enable Access Analyzer findings integration)
- firewall_manager: false (disabled by default - enable if using Firewall Manager)

Note: Product subscriptions can be enabled even if the source service is not yet deployed.
The subscription will simply wait for findings once the service is enabled.

For more information, see:
https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-providers.html
object({
guardduty = optional(bool, true)
inspector = optional(bool, true)
macie = optional(bool, true)
config = optional(bool, true)
access_analyzer = optional(bool, true)
firewall_manager = optional(bool, false)
})
{} no
regex_replace_chars 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.
string null no
region AWS Region string n/a yes
root_account_stage The stage name for the Organization root (management) account. This is used to lookup account IDs from account names
using the account-map component.
string "root" no
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null no
subscribers A map of subscription configurations for SNS topics

For more information, see:
https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic_subscription#argument-reference

protocol:
The protocol to use. The possible values for this are: sqs, sms, lambda, application. (http or https are partially
supported, see link) (email is an option but is unsupported in terraform, see link).
endpoint:
The endpoint to send data to, the contents will vary with the protocol. (see link for more information)
endpoint_auto_confirms:
Boolean indicating whether the end point is capable of auto confirming subscription e.g., PagerDuty. Default is
false.
raw_message_delivery:
Boolean indicating whether or not to enable raw message delivery (the original message is directly passed, not
wrapped in JSON with the original message in the message property). Default is false.
map(object({
protocol = string
endpoint = string
endpoint_auto_confirms = bool
raw_message_delivery = bool
}))
{} no
tags Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string) {} no
tenant ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for string null no

Outputs

Name Description
delegated_administrator_account_id The AWS Account ID of the AWS Organization delegated administrator account
product_subscriptions ARNs of Security Hub product subscriptions for AWS service integrations
sns_topic_name The name of the SNS topic created by the component
sns_topic_subscriptions The SNS topic subscriptions created by the component

Related Projects

Check out these related projects.

References

For additional context, refer to some of these links.

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

βœ… We build it together with your team.
βœ… Your team owns everything.
βœ… 100% Open Source and backed by fanatical support.

Request Quote

πŸ“š Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

  • Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
  • Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
  • Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
  • Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
  • GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Request Quote

Day-2: Your Operational Mastery

  • Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
  • Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
  • Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
  • Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
  • Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
  • Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
  • Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

Request Quote

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For πŸ› bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Running Terraform Tests

We use Atmos to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.

All tests are located in the test/ folder.

Under the hood, tests are powered by Terratest together with our internal Test Helpers library, providing robust infrastructure validation.

Setup dependencies:

To run tests:

  • Run all tests:
    atmos test run
  • Clean up test artifacts:
    atmos test clean
  • Explore additional test options:
    atmos test --help

The configuration for test commands is centrally managed. To review what's being imported, see the atmos.yaml file.

Learn more about our automated testing in our documentation or implementing custom commands with atmos.

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

πŸ“° Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week β€” and usually a 5-minute read.

πŸ“† Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

License

Preamble to the Apache License, Version 2.0

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.


Copyright Β© 2017-2025 Cloud Posse, LLC

README footer

Beacon

About

This component is responsible for configuring Security Hub within an AWS Organization

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Contributors 12