Control types for @turbot/aws-cloudtrail
- AWS > CloudTrail > Shadow Trail > CMDB
- AWS > CloudTrail > Shadow Trail > Discovery
- AWS > CloudTrail > Trail > Active
- AWS > CloudTrail > Trail > Approved
- AWS > CloudTrail > Trail > CMDB
- AWS > CloudTrail > Trail > Configured
- AWS > CloudTrail > Trail > Discovery
- AWS > CloudTrail > Trail > Encryption at Rest
- AWS > CloudTrail > Trail > Log File Validation
- AWS > CloudTrail > Trail > Tags
- AWS > CloudTrail > Trail > Trail Status
- AWS > CloudTrail > Trail > Usage
AWS > CloudTrail > Shadow Trail > CMDB
Record and synchronize details for the AWS CloudTrail shadow trail into the CMDB.\n\nA shadow trail is the replication in a region of a trail that was created in a different region, or in the case of an organization trail, the replication of an organization trail in member accounts.\n\nThe CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.\n\nIf set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.\n\nTo cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".\n\nCMDB controls also use the Regions policy associated with the resource. If region is not in AWS > CloudTrail > Shadow Trail > Regions
policy, the CMDB control will delete the resource from the CMDB. (Note: Setting CMDB to Skip will also pause these changes.)\n\nThis control will automatically re-run every 24 hours because AWS does not currently support real-time events for all properties of this resource type.\n
AWS > CloudTrail > Shadow Trail > Discovery
Discover all AWS CloudTrail shadow trail resources and add them to the CMDB.\n\nA shadow trail is the replication in a region of a trail that was created in a different region, or in the case of an organization trail, the replication of an organization trail in member accounts.\n\nThe Discovery control is responsible for finding resources of a specific type. It periodically searches for new resources and saves them to the CMDB. Once discovered, resources are then responsible for tracking changes to themselves through the CMDB control.\n\nNote that Discovery and CMDB controls also use the Regions policy associated with the resource. If the region is not in AWS > CloudTrail > Shadow Trail > Regions
policy, the CMDB control will delete the resource from the CMDB.\n\nThis control will automatically re-run every 24 hours because AWS does not currently support real-time events for all properties of this resource type.\n
AWS > CloudTrail > Trail > Active
Take an action when an AWS CloudTrail trail is not active based on the\nAWS > CloudTrail > Trail > Active > *
policies.\n\nThe Active control determines whether the resource is in active use, and if not, has\nthe ability to delete / cleanup the resource. When running an automated compliance\nenvironment, it's common to end up with a wide range of alarms that are difficult\nand time consuming to clear. The Active control brings automated, well-defined\ncontrol to this process.\n\nThe Active control checks the status of all defined Active policies for the\nresource (AWS > CloudTrail > Trail > Active > *
),\nraises an alarm, and takes the defined enforcement action. Each Active\nsub-policy can calculate a status of active, inactive or skipped. Generally,\nif the resource appears to be Active for any reason it will be considered Active.\n\nNote the contrast with Approved, where if the resource appears to be Unapproved\nfor any reason it will be considered Unapproved.\n\nSee Active for more information.\n
AWS > CloudTrail > Trail > Approved
Take an action when an AWS CloudTrail trail is not approved based on AWS > CloudTrail > Trail > Approved > * policies
.\n\nThe Approved control checks the status of the defined Approved sub-policies for the resource. If the resource is not approved according to any of these policies, this control raises an alarm and takes the defined enforcement action.\n\nFor any enforcement actions that specify if new
, e.g., Enforce: Delete unapproved if new
, this control will only take the enforcement actions for resources created within the last 60 minutes.\n\nSee Approved for more information.\n
AWS > CloudTrail > Trail > CMDB
Record and synchronize details for the AWS CloudTrail trail into the CMDB.\n\nThe CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.\n\nIf set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.\n\nTo cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".\n\nCMDB controls also use the Regions policy associated with the resource. If region is not in AWS > CloudTrail > Trail > Regions
policy, the CMDB control will delete the resource from the CMDB. (Note: Setting CMDB to Skip will also pause these changes.)\n\nThis control will automatically re-run every 24 hours because AWS does not currently support real-time events for all properties of this resource type.\n
AWS > CloudTrail > Trail > Configured
Maintain AWS > CloudTrail > Trail configuration\n\nNote: If the resource is managed by another stack, then the Skip/Check/Enforce values here are ignored\nand inherit from the stack that owns it\n
AWS > CloudTrail > Trail > Discovery
Discover all AWS CloudTrail trail resources and add them to the CMDB.\n\nThe Discovery control is responsible for finding resources of a specific type. It periodically searches for new resources and saves them to the CMDB. Once discovered, resources are then responsible for tracking changes to themselves through the CMDB control.\n\nNote that Discovery and CMDB controls also use the Regions policy associated with the resource. If the region is not in AWS > CloudTrail > Trail > Regions
policy, the CMDB control will delete the resource from the CMDB.\n
AWS > CloudTrail > Trail > Encryption at Rest
Define the Encryption at Rest settings required for AWS > CloudTrail > Trail
.\n\nEncryption at Rest refers specifically to the encryption of data when written\nto an underlying storage system. This control determines whether the resource\nis encrypted at rest, and sets encryption to your desired level.\n\nThe Encryption at Rest\ncontrol compares the encryption settings against the encryption policies for the resource\n(AWS > CloudTrail > Trail > Encryption at Rest > *
),\nraises an alarm, and takes the defined enforcement action.\n
AWS > CloudTrail > Trail > Log File Validation
Check if CloudTrail trail log file validation is configured correctly.
AWS > CloudTrail > Trail > Tags
Take an action when an AWS CloudTrail trail tags is not updated based on the AWS > CloudTrail > Trail > Tags > * policies
.\n\nIf the resource is not updated with the tags defined in AWS > CloudTrail > Trail > Tags > Template
, this control raises an alarm and takes the defined enforcement action.\n\nSee Tags for more information.\n
AWS > CloudTrail > Trail > Trail Status
Check if a CloudTrail trail has any delivery errors.
AWS > CloudTrail > Trail > Usage
The Usage control determines whether the number of AWS CloudTrail trail resources exceeds the configured usage limit for this region.\n\nYou can configure the behavior of this control with the AWS > CloudTrail > Trail > Usage
policy, and set the limit with the AWS > CloudTrail > Trail > Usage > Limit
policy.\n