Skip to main content

Component: security-hub

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.

Here are the key features and capabilities of Amazon Security Hub:

  • Centralized security management: Security Hub provides a centralized dashboard where users can view and manage security findings from multiple AWS accounts and regions. This allows for a unified view of the security posture across the entire AWS environment.

  • Automated security checks: Security Hub automatically performs continuous security checks on AWS resources, configurations, and security best practices. It leverages industry standards and compliance frameworks, such as AWS CIS Foundations Benchmark, to identify potential security issues.

  • Integrated partner solutions: Security Hub integrates with a wide range of AWS native services, as well as third-party security products and solutions. This integration enables the ingestion and analysis of security findings from diverse sources, offering a comprehensive security view.

  • Security standards and compliance: Security Hub provides compliance checks against industry standards and regulatory frameworks, such as PCI DSS, HIPAA, and GDPR. It identifies non-compliant resources and provides guidance on remediation actions to ensure adherence to security best practices.

  • Prioritized security findings: Security Hub analyzes and prioritizes security findings based on severity, enabling users to focus on the most critical issues. It assigns severity levels and generates a consolidated view of security alerts, allowing for efficient threat response and remediation.

  • Custom insights and event aggregation: Security Hub supports custom insights, allowing users to create their own rules and filters to focus on specific security criteria or requirements. It also provides event aggregation and correlation capabilities to identify related security findings and potential attack patterns.

  • Integration with other AWS services: Security Hub seamlessly integrates with other AWS services, such as AWS CloudTrail, Amazon GuardDuty, AWS Config, and AWS IAM Access Analyzer. This integration allows for enhanced visibility, automated remediation, and streamlined security operations.

  • Alert notifications and automation: Security Hub supports alert notifications through Amazon SNS, enabling users to receive real-time notifications of security findings. It also facilitates automation and response through integration with AWS Lambda, allowing for automated remediation actions.

By utilizing Amazon Security Hub, organizations can improve their security posture, gain insights into security risks, and effectively manage security compliance across their AWS accounts and resources.


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
component: security-hub
enabled: true
delegated_administrator_account_name: core-security
environment: ue1
region: us-east-1
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
component: security-hub
role_arn: null
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
component: security-hub
enabled: true
delegated_administrator_account_name: core-security
environment: use1
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


terraform>= 1.0.0
aws>= 5.0
awsutils>= 0.16.0


aws>= 5.0
awsutils>= 0.16.0




aws_caller_identity.thisdata source
aws_region.thisdata source


account_map_tenantThe tenant where the account_map component required by remote-state is deployedstring"core"no
additional_tag_mapAdditional 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.
admin_delegatedA flag to indicate if the AWS Organization-wide settings should be created. This can only be done after the Security
Hub Admininstrator account has already been delegated from the AWS Org Management account (usually 'root'). See the
Deployment section of the README for more information.
attributesID 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.
auto_enable_organization_membersFlag to toggle auto-enablement of Security Hub for new member accounts in the organization.

For more information, see:
cloudwatch_event_rule_pattern_detail_typeThe detail-type pattern used to match events that will be sent to SNS.

For more information, see:
string"ecurity Hub Findings - Imported"no
contextSingle 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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
create_sns_topicFlag 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.
default_standards_enabledFlag to indicate whether default standards should be enabledbooltrueno
delegated_administrator_account_nameThe name of the account that is the AWS Organization Delegated Administrator accountstring"core-security"no
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe 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).
enabledSet to false to prevent the module from creating any resourcesboolnullno
enabled_standardsA 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
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
finding_aggregation_regionIf finding aggreation is enabled, the region that collects findingsstringnullno
finding_aggregator_enabledFlag 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:
finding_aggregator_linking_modeLinking 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
finding_aggregator_regionsA list of regions to aggregate findings from.

This is only used if finding_aggregator_enabled is true.
findings_notification_arnThe 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.
global_environmentGlobal environment namestring"gbl"no
id_length_limitLimit 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.
import_profile_nameAWS Profile name to use when importing a resourcestringnullno
import_role_arnIAM Role ARN to use when importing a resourcestringnullno
label_key_caseControls 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.
label_orderThe 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.
label_value_caseControls 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.
labels_as_tagsSet 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.
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.
nameID 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.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
organization_management_account_nameThe name of the AWS Organization management accountstringnullno
privilegedtrue if the default provider already has access to the backendboolfalseno
regex_replace_charsTerraform 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.
regionAWS Regionstringn/ayes
root_account_stageThe stage name for the Organization root (management) account. This is used to lookup account IDs from account names
using the account-map component.
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
subscribersA map of subscription configurations for SNS topics

For more information, see:

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).
The endpoint to send data to, the contents will vary with the protocol. (see link for more information)
Boolean indicating whether the end point is capable of auto confirming subscription e.g., PagerDuty. Default is
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.
protocol = string
endpoint = string
endpoint_auto_confirms = bool
raw_message_delivery = bool
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno


delegated_administrator_account_idThe AWS Account ID of the AWS Organization delegated administrator account
sns_topic_nameThe name of the SNS topic created by the component
sns_topic_subscriptionsThe SNS topic subscriptions created by the component