Skip to main content

Component: guardduty

This component is responsible for configuring GuardDuty within an AWS Organization.

AWS GuardDuty is a managed threat detection service. It is designed to help protect AWS accounts and workloads by continuously monitoring for malicious activities and unauthorized behaviors. To detect potential security threats, GuardDuty analyzes various data sources within your AWS environment, such as AWS CloudTrail logs, VPC Flow Logs, and DNS logs.

Key features and components of AWS GuardDuty include:

  • Threat detection: GuardDuty employs machine learning algorithms, anomaly detection, and integrated threat intelligence to identify suspicious activities, unauthorized access attempts, and potential security threats. It analyzes event logs and network traffic data to detect patterns, anomalies, and known attack techniques.

  • Threat intelligence: GuardDuty leverages threat intelligence feeds from AWS, trusted partners, and the global community to enhance its detection capabilities. It uses this intelligence to identify known malicious IP addresses, domains, and other indicators of compromise.

  • Real-time alerts: When GuardDuty identifies a potential security issue, it generates real-time alerts that can be delivered through AWS CloudWatch Events. These alerts can be integrated with other AWS services like Amazon SNS or AWS Lambda for immediate action or custom response workflows.

  • Multi-account support: GuardDuty can be enabled across multiple AWS accounts, allowing centralized management and monitoring of security across an entire organization's AWS infrastructure. This helps to maintain consistent security policies and practices.

  • Automated remediation: GuardDuty integrates with other AWS services, such as AWS Macie, AWS Security Hub, and AWS Systems Manager, to facilitate automated threat response and remediation actions. This helps to minimize the impact of security incidents and reduces the need for manual intervention.

  • Security findings and reports: GuardDuty provides detailed security findings and reports that include information about detected threats, affected AWS resources, and recommended remediation actions. These findings can be accessed through the AWS Management Console or retrieved via APIs for further analysis and reporting.

GuardDuty offers a scalable and flexible approach to threat detection within AWS environments, providing organizations with an additional layer of security to proactively identify and respond to potential security risks.


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 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 Admininstrator Account

First, the component is deployed to the Delegated Admininstrator account in each region in order to configure the central GuardDuty detector that each account will send its findings to.

# core-ue1-security
component: guardduty
enabled: true
delegated_administrator_account_name: core-security
environment: ue1
region: us-east-1
atmos terraform apply guardduty/delegated-administrator/ue1 -s core-ue1-security
atmos terraform apply guardduty/delegated-administrator/ue2 -s core-ue2-security
atmos terraform apply guardduty/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 Admininstrator account.

Note that you must use the SuperAdmin permissions as we are deploying to the AWS Organization Managment 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: guardduty
role_arn: null
enabled: true
delegated_administrator_account_name: core-security
environment: ue1
region: us-east-1
privileged: true
atmos terraform apply guardduty/root/ue1 -s core-ue1-root
atmos terraform apply guardduty/root/ue2 -s core-ue2-root
atmos terraform apply guardduty/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 configuration for the AWS Organization, but with var.admin_delegated set to true to indicate that the delegation has already been performed from the Organization Management account.

# core-ue1-security
component: guardduty
enabled: true
delegated_administrator_account_name: core-security
environment: use1
region: us-east-1
admin_delegated: true
atmos terraform apply guardduty/org-settings/ue1 -s core-ue1-security
atmos terraform apply guardduty/org-settings/ue2 -s core-ue2-security
atmos terraform apply guardduty/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


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 GuardDuty
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_membersIndicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. Valid values are ALL, NEW, NONE.

For more information, see:
cloudwatch_enabledFlag to indicate whether CloudWatch logging should be enabled for GuardDutyboolfalseno
cloudwatch_event_rule_pattern_detail_typeThe detail-type pattern used to match events that will be sent to SNS.

For more information, see:
string"GuardDuty Finding"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.
delegated_admininstrator_component_nameThe name of the component that created the GuardDuty detector.string"guardduty/delegated-administrator"no
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
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
finding_publishing_frequencyThe frequency of notifications sent for finding occurrences. If the detector is a GuardDuty member account, the value
is determined by the GuardDuty master account and cannot be modified, otherwise it defaults to SIX_HOURS.

For standalone and GuardDuty master accounts, it must be configured in Terraform to enable drift detection.
Valid values for standalone and master accounts: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS."

For more information, see:
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.
kubernetes_audit_logs_enabledIf true, enables Kubernetes audit logs as a data source for Kubernetes protection.

For more information, see:
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.
malware_protection_scan_ec2_ebs_volumes_enabledConfigure whether Malware Protection is enabled as data source for EC2 instances EBS Volumes in GuardDuty.

For more information, see:
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.
s3_protection_enabledIf true, enables S3 protection.

For more information, see:
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
guardduty_detector_arnThe ARN of the GuardDuty detector created by the component
guardduty_detector_idThe ID of the GuardDuty detector created by the component
sns_topic_nameThe name of the SNS topic created by the component
sns_topic_subscriptionsThe SNS topic subscriptions created by the component