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.

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

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.

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

To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".

CMDB 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.)

This control will automatically re-run every 24 hours because AWS does not currently support real-time events for all properties of this resource type.

AWS > CloudTrail > Shadow Trail > Discovery

Discover all AWS CloudTrail shadow trail resources and add them to the CMDB.

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

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

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

This control will automatically re-run every 24 hours because AWS does not currently support real-time events for all properties of this resource type.

AWS > CloudTrail > Trail > Active

Take an action when an AWS CloudTrail trail is not active based on the
AWS > CloudTrail > Trail > Active > * policies.

The Active control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated compliance
environment, it's common to end up with a wide range of alarms that are difficult
and time consuming to clear. The Active control brings automated, well-defined
control to this process.

The Active control checks the status of all defined Active policies for the
resource (AWS > CloudTrail > Trail > Active > *),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.

Note the contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.

See Active for more information.

AWS > CloudTrail > Trail > Approved

Take an action when an AWS CloudTrail trail is not approved based on AWS > CloudTrail > Trail > Approved > * policies.

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

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

See Approved for more information.

AWS > CloudTrail > Trail > CMDB

Record and synchronize details for the AWS CloudTrail trail into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.

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

To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".

CMDB 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.)

This control will automatically re-run every 24 hours because AWS does not currently support real-time events for all properties of this resource type.

AWS > CloudTrail > Trail > Configured

Maintain AWS > CloudTrail > Trail configuration

Note: If the resource is managed by another stack, then the Skip/Check/Enforce values here are ignored
and inherit from the stack that owns it

AWS > CloudTrail > Trail > Discovery

Discover all AWS CloudTrail trail resources and add them to the CMDB.

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

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

AWS > CloudTrail > Trail > Encryption at Rest

Define the Encryption at Rest settings required for AWS > CloudTrail > Trail.

Encryption at Rest refers specifically to the encryption of data when written
to an underlying storage system. This control determines whether the resource
is encrypted at rest, and sets encryption to your desired level.

The Encryption at Rest
control compares the encryption settings against the encryption policies for the resource
(AWS > CloudTrail > Trail > Encryption at Rest > *),
raises an alarm, and takes the defined enforcement action.

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.

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

See Tags for more information.

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.

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