Enable Global Event Handlers for AWS Accounts
The Guardrails Event Handlers are responsible for conveying events from AWS CloudTrail back to Guardrails for processing. This is a requirement for Guardrails to process and respond in real-time.
This policy pack can help you enable Global Event Handlers for AWS Accounts in Guardrails.
Getting Started
Requirements
Guardrails mods:
IAM Role ARN used to forward events from the non-primary regions to the Primary Region. You can use enable_iam_service_roles Policy Pack to create this IAM role
The below permissions are needed at minimum to allow the role to forward events to the Primary Region correctly:
{"Statement": [{"Action": ["events:PutEvents"],"Effect": "Allow","Resource": "arn:<partition>:events:<region>:<accountId>:event-bus/default"}],"Version": "2012-10-17"}
Credentials
To create a policy pack through Terraform:
- Ensure you have
Turbot/Admin
permissions (or higher) in Guardrails - Create access keys in Guardrails
And then set your credentials:
export TURBOT_WORKSPACE=myworkspace.acme.comexport TURBOT_ACCESS_KEY=acce6ac5-access-key-hereexport TURBOT_SECRET_KEY=a8af61ec-secret-key-here
Please see Turbot Guardrails Provider authentication for additional authentication methods.
Usage
Install Policy Pack
NoteBy default, installed policy packs are not attached to any resources.
Policy packs must be attached to resources in order for their policy settings to take effect.
Clone:
git clone https://github.com/turbot/guardrails-samples.gitcd guardrails-samples/policy_packs/aws/guardrails/enable_global_event_handlers
Run the Terraform to create the policy pack in your workspace:
terraform initterraform plan
Then apply the changes:
terraform apply
Apply Policy Pack
Log into your Guardrails workspace and attach the policy pack to a resource.
If this policy pack is attached to a Guardrails folder, its policies will be applied to all accounts and resources in that folder. The policy pack can also be attached to multiple resources.
For more information, please see Policy Packs.
Enable Enforcement
TipYou can also update the policy settings in this policy pack directly in the Guardrails console.
Please note your Terraform state file will then become out of sync and the policy settings should then only be managed in the console.
By default, the policies are set to Check
in the pack's policy settings. To enable automated enforcements, you can switch these policies settings by adding a comment to the Check
setting and removing the comment from one of the listed enforcement options:
ImportantSetting the policy in enforce mode will result in creation of resources in the target account. However, it is easy to remove those resources later, by setting the Stack's policy to
Enforce: Not configured
.
resource "turbot_policy_setting" "aws_turbot_event_handlers_global" { resource = turbot_policy_pack.main.id type = "tmod:@turbot/aws#/policy/types/eventHandlersGlobal" # value = "Check: Configured" value = "Enforce: Configured"}
Then re-apply the changes:
terraform planterraform apply