Control types for @turbot/aws-wellarchitected

• AWS > Well-Architected Tool > AWS Well-Architected Framework > CMDB
• AWS > Well-Architected Tool > AWS Well-Architected Framework > Discovery
• AWS > Well-Architected Tool > Workload > Active
• AWS > Well-Architected Tool > Workload > Approved
• AWS > Well-Architected Tool > Workload > CMDB
• AWS > Well-Architected Tool > Workload > Discovery
• AWS > Well-Architected Tool > Workload > Tags
• AWS > Well-Architected Tool > Workload > Usage

AWS > Well-Architected Tool > AWS Well-Architected Framework > CMDB

Record and synchronize details for the AWS Well-Architected Tool aws well-architected framework 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".

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

AWS > Well-Architected Tool > AWS Well-Architected Framework > Discovery

Discover all AWS Well-Architected Tool aws well-architected framework 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.

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 > Well-Architected Tool > Workload > Active

Take an action when an AWS Well-Architected Tool workload is not active based on the
AWS > Well-Architected Tool > Workload > 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 > Well-Architected Tool > Workload > 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 > Well-Architected Tool > Workload > Approved

Take an action when an AWS Well-Architected Tool workload is not approved based on AWS > Well-Architected Tool > Workload > 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 > Well-Architected Tool > Workload > CMDB

Record and synchronize details for the AWS Well-Architected Tool workload 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 > Well-Architected Tool > Workload > 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 this resource type.

AWS > Well-Architected Tool > Workload > Discovery

Discover all AWS Well-Architected Tool workload 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 > Well-Architected Tool > Workload > Regions policy, the CMDB control will delete the resource from the CMDB.

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

AWS > Well-Architected Tool > Workload > Tags

Take an action when an AWS Well-Architected Tool workload tags is not updated based on the AWS > Well-Architected Tool > Workload > Tags > * policies.

If the resource is not updated with the tags defined in AWS > Well-Architected Tool > Workload > Tags > Template, this control raises an alarm and takes the defined enforcement action.

See Tags for more information.

AWS > Well-Architected Tool > Workload > Usage

The Usage control determines whether the number of AWS Well-Architected Tool workload resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > Well-Architected Tool > Workload > Usage policy, and set the limit with the AWS > Well-Architected Tool > Workload > Usage > Limit policy.