README.md

May 12, 2026 · View on GitHub

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.
Automation Rules: Supports org-wide Security Hub automation rules for suppressing known false-positive control findings without disabling the control entirely.
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
Organizations Delegation Policy: Automatically creates the 8-statement Organizations resource-based delegation policy required for Security Hub console access in the delegated administrator account
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)
Account Verification: Optional safety check that validates Terraform is running in the correct AWS account
Flexible Account Map: Supports both remote-state account-map lookups and static account map variables (default)
Finding Suppression via Automation Rules: Configurable automation rules that suppress specific control findings org-wide from the delegated administrator account, without disabling controls or migrating to CENTRAL configuration mode

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-use1-security
components:
  terraform:
    aws-security-hub/delegated-administrator:
      metadata:
        component: aws-security-hub
      vars:
        enabled: true
        delegated_administrator_account_name: core-security
        # Product subscriptions for AWS security service integrations
        product_subscriptions:
          guardduty: true        # Enable GuardDuty findings
          inspector: true        # Enable Inspector findings
          macie: false           # Disabled by default - enable if using Macie
          config: true           # Enable Config findings
          access_analyzer: true  # Enable Access Analyzer findings
          firewall_manager: false # Disabled by default

atmos terraform apply aws-security-hub/delegated-administrator -s core-use1-security
atmos terraform apply aws-security-hub/delegated-administrator -s core-use2-security
atmos terraform apply aws-security-hub/delegated-administrator -s core-usw1-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. This step also creates the Organizations resource-based delegation policy that grants the delegated administrator permissions to manage Security Hub policies via Organizations APIs.

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-use1-root
components:
  terraform:
    aws-security-hub/root:
      metadata:
        component: aws-security-hub
      vars:
        enabled: true
        delegated_administrator_account_name: core-security
        privileged: true

atmos terraform apply aws-security-hub/root -s core-use1-root
atmos terraform apply aws-security-hub/root -s core-use2-root
atmos terraform apply aws-security-hub/root -s core-usw1-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. This step uses LOCAL configuration mode where each account manages its own configuration, and auto-enables Security Hub for all member accounts.

# core-use1-security
components:
  terraform:
    aws-security-hub/org-settings:
      metadata:
        component: aws-security-hub
      vars:
        enabled: true
        delegated_administrator_account_name: core-security
        admin_delegated: true

atmos terraform apply aws-security-hub/org-settings -s core-use1-security
atmos terraform apply aws-security-hub/org-settings -s core-use2-security
atmos terraform apply aws-security-hub/org-settings -s core-usw1-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	`false`	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 aws-security-hub/delegated-administrator -s core-use1-security

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

Delegation Policy

Step 2 (root account deployment) creates an Organizations resource-based delegation policy with 8 policy statements that grant the delegated administrator account permissions to manage Security Hub policies via Organizations APIs. This policy is required even when using LOCAL configuration mode, because the Security Hub console checks for it when displaying central configuration management options.

Key details:

The policy uses organizations:* actions (not securityhub:*). Organizations resource policies only support organizations:* actions.
AWS expects exactly 8 policy statements, including SecurityServicesDelegating* statements with resource ARNs scoped to the organization ID.
The policy includes resources for both securityhub_policy and inspector_policy types (shared delegation mechanism).
aws_organizations_resource_policy is an organization-wide singleton. Only one can exist per organization. If other services need delegation policies, their statements must be combined into a single policy.
Set organizations_resource_policy_enabled = false if the Organizations resource policy is managed by another component or service.

Troubleshooting: "Missing Permissions to Manage Policies"

If the delegated administrator sees this error in the Security Hub console:

You are missing permissions that are required to manage policies in Security Hub.

This means the Organizations resource-based delegation policy is missing or incomplete. Re-apply Step 2:

atmos terraform apply aws-security-hub/root -s core-use1-root

Automation Rules (Suppress False-Positive Findings)

Security Hub automation rules let you mutate findings as they are ingested — for example, marking findings from a known false-positive control as SUPPRESSED so they stop showing up in the active dashboard. Rules created in the delegated administrator account apply org-wide and work in LOCAL configuration mode (no CENTRAL migration required).

This component exposes a disabled_control_finding_reasons variable that creates one aws_securityhub_automation_rule per entry. Rules are only created during Step 3 (org-settings deployment, admin_delegated = true), so they live in the delegated administrator account alongside aws_securityhub_organization_configuration.

Example: Suppress Config.1 false positive

The CloudPosse aws-config module provisions a custom IAM role for the AWS Config recorder. Security Hub's Config.1 control then flags every account with reason code CONFIG_RECORDER_CUSTOM_ROLE, even though the custom role is a valid deployment pattern.

# core-use1-security
components:
  terraform:
    aws-security-hub/org-settings:
      vars:
        enabled: true
        admin_delegated: true
        disabled_control_finding_reasons:
          config-1-custom-role:
            control_id: "Config.1"
            reason_code: "CONFIG_RECORDER_CUSTOM_ROLE"
            disabled_reason: >-
              False positive: CloudPosse aws-config module uses a custom IAM role
              with equivalent permissions instead of AWSServiceRoleForConfig.

The resulting rule matches every FAILED / ACTIVE finding for the given control_id and sets workflow status to SUPPRESSED with a note containing disabled_reason. New findings are suppressed immediately; existing findings are re-evaluated by Security Hub (typically within 12–24 hours).

Variable reference

Field	Required	Description
`control_id`	yes	Security Hub control ID (e.g., `Config.1`). The rule fires on every `FAILED`/`ACTIVE` finding for this control.
`reason_code`	no	Optional label appended to the rule name. Documentation only — Security Hub's automation rule API cannot filter on `Compliance.StatusReasons[].ReasonCode`.
`disabled_reason`	yes	Human-readable justification. Used as the rule description and as the note added to suppressed findings.
`rule_order`	no	Rule precedence (1–1000, lower runs first). Defaults to `1`. Only relevant when multiple rules could match the same finding (rules are terminal — first wins).

Caveats

No reason-code filtering: AWS does not expose ReasonCode as a criterion for automation rules, so the suppression applies to all FAILED findings for the configured control_id. If a control can fail for multiple distinct reasons and you want to suppress only one, you must either accept the broader suppression or migrate to CENTRAL configuration mode and use aws_securityhub_configuration_policy parameter overrides.
Singleton-aware: Rules use for_each, so adding/removing entries does not affect other entries.
Rollback: Removing an entry from the map deletes the rule on the next apply. Previously suppressed findings revert to their original workflow status on the next Security Hub evaluation cycle.

Verification

# List automation rules in the delegated administrator account
aws securityhub list-automation-rules --region us-east-1

# Check that Config.1 findings are now suppressed
aws securityhub get-findings \
  --filters '{
    "ComplianceSecurityControlId": [{"Value": "Config.1", "Comparison": "EQUALS"}],
    "WorkflowStatus": [{"Value": "SUPPRESSED", "Comparison": "EQUALS"}]
  }' \
  --query 'length(Findings)'

Account Map Configuration

The component supports two modes for resolving AWS account IDs:

Static Mode (default)

When account_map_enabled = false (default), the component uses a static account_map variable instead of remote state. This is useful when not using the account-map component or when account mappings are managed externally (e.g., by Atmos).

Remote State Mode

When account_map_enabled = true, the component fetches account mappings from the account-map component via Terraform remote state. This is the standard Cloud Posse reference architecture pattern.

vars:
  account_map_enabled: false
  account_map:
    full_account_map:
      core-root: "111111111111"
      core-security: "222222222222"
      core-audit: "333333333333"
      plat-dev: "444444444444"
      plat-prod: "555555555555"
    root_account_account_name: "core-root"

When using static mode, provider authentication is handled externally (e.g., by Atmos identity resolution) rather than through the iam-roles module.

Account Verification

When account_verification_enabled = true (default), the component verifies that Terraform is executing in the correct AWS account by comparing the current account ID against the expected account ID from the account map, based on the component's tenant-stage context. This provides a safety check to catch misconfigurations before any resources are created or modified.

To disable account verification:

vars:
  account_verification_enabled: false

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.4.0
aws	>= 5.33.0
awsutils	>= 0.16.0

Providers

Name	Version
aws	>= 5.33.0
awsutils	>= 0.16.0
terraform	n/a

Modules

Name	Source	Version
account_map	cloudposse/stack-config/yaml//modules/remote-state	1.8.0
security_hub	cloudposse/security-hub/aws	0.12.2
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_organizations_resource_policy.security_hub	resource
aws_securityhub_account.this	resource
aws_securityhub_automation_rule.suppress_control_findings	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
terraform_data.account_verification	resource
aws_caller_identity.this	data source
aws_organizations_organization.this	data source
aws_partition.this	data source
aws_region.this	data source

Inputs

Name	Description	Type	Default	Required
account_map	Static account map configuration. Only used when `account_map_enabled` is `false`. Map keys use `tenant-stage` format (e.g., `core-security`, `core-audit`, `plat-prod`).	object({ full_account_map = map(string) audit_account_account_name = optional(string, "") root_account_account_name = optional(string, "") identity_account_account_name = optional(string, "") aws_partition = optional(string, "aws") iam_role_arn_templates = optional(map(string), {}) })	{ "audit_account_account_name": "", "aws_partition": "aws", "full_account_map": {}, "iam_role_arn_templates": {}, "identity_account_account_name": "", "root_account_account_name": "" }	no
account_map_component_name	The name of the account-map component	`string`	`"account-map"`	no
account_map_enabled	Enable the account map component. When true, the component fetches account mappings from the `account-map` component via remote state. When false (default), the component uses the static `account_map` variable instead.	`bool`	`false`	no
account_map_tenant	The tenant where the `account_map` component required by remote-state is deployed	`string`	`"core"`	no
account_verification_enabled	Enable account verification. When true (default), the component verifies that Terraform is executing in the correct AWS account by comparing the current account ID against the expected account from the account_map based on the component's tenant-stage context.	`bool`	`true`	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
disabled_control_finding_reasons	A map of Security Hub automation rules to suppress specific control findings. Each entry creates an automation rule (in the delegated administrator account) that sets matching findings to `SUPPRESSED`. - control_id: The Security Hub control ID (e.g., "Config.1"). This is the only field used for matching; the rule fires on every FAILED/ACTIVE finding for the given control. - reason_code: Optional label appended to the rule name (e.g., "CONFIG_RECORDER_CUSTOM_ROLE"). Documentation/traceability only — Security Hub's automation rule API does not support filtering on `Compliance.StatusReasons[].ReasonCode`, so the suppression applies to all FAILED findings for `control_id`, regardless of the underlying reason. - disabled_reason: Human-readable justification for the suppression, stored as the rule description and as the note on suppressed findings. - rule_order: Optional rule precedence (1–1000, lower runs first). Defaults to 1. Only relevant when multiple rules could match the same finding; rules are terminal, so the first match wins. Rules only deploy when running in the delegated administrator account with `admin_delegated = true` (i.e., the same gate as `aws_securityhub_organization_configuration`).	map(object({ control_id = string reason_code = optional(string) disabled_reason = string rule_order = optional(number, 1) }))	`{}`	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`	`"us-east-1"`	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`	`true`	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
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
organizations_resource_policy_enabled	Enable creation of the Organizations resource-based delegation policy for Security Hub. When true (default), the component creates an `aws_organizations_resource_policy` in the management account (Step 2) that grants the delegated administrator permissions to manage Security Hub policies via Organizations APIs. Set to `false` if the Organizations resource policy is managed elsewhere (e.g., by another component or service). Note: `aws_organizations_resource_policy` is an organization-wide singleton — only one can exist per organization. If other services (e.g., AWS Backup, Inspector) need delegation policies, their statements must be combined into a single policy managed by one component.	`bool`	`true`	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: false (disabled by default - enable if using Macie) - 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, false) 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

Check out these related projects.

Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
Atmos - Atmos is like docker-compose but for your infrastructure
terraform-aws-security-hub - Terraform module to provision AWS Security Hub
aws-guardduty - Component for AWS GuardDuty threat detection
aws-config - Component for AWS Config compliance management
aws-inspector2 - Component for AWS Inspector vulnerability scanning

References

For additional context, refer to some of these links.

AWS Security Hub Documentation - Official AWS documentation for Security Hub
Security Hub Organization Administration - Managing Security Hub across AWS Organizations
Security Hub Product Integrations - Integrating AWS services with Security Hub via product subscriptions
Security Hub Standards - Security standards and compliance frameworks in Security Hub
Security Hub Finding Aggregation - Cross-region finding aggregation configuration
CloudPosse Security Hub Terraform Module - The underlying Terraform module used by this component
Cloud Posse's upstream component - Original component in terraform-aws-components

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.

📚 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.

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.

✨ 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.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
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:

Install Atmos (installation guide)
Install Go 1.24+ or newer
Install Terraform or OpenTofu

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.

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

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.