Control types for @turbot/aws-config

AWS > Config > Configuration Recorder > Active

Take an action when an AWS Config configuration recorder is not active based on the
AWS > Config > Configuration Recorder > 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 > Config > Configuration Recorder > 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.

URI
tmod:@turbot/aws-config#/control/types/configurationRecorderActive

AWS > Config > Configuration Recorder > Approved

Take an action when an AWS Config configuration recorder is not approved based on AWS > Config > Configuration Recorder > 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.

URI
tmod:@turbot/aws-config#/control/types/configurationRecorderApproved

AWS > Config > Configuration Recorder > CMDB

Record and synchronize details for the AWS Config configuration recorder 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 > Config > Configuration Recorder > Regions policy, the CMDB control will delete the resource from the CMDB. (Note: Setting CMDB to Skip will also pause these changes.)

URI
tmod:@turbot/aws-config#/control/types/configurationRecorderCmdb
Category

AWS > Config > Configuration Recorder > Configured

Maintain AWS > Config > Configuration Recorder 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

URI
tmod:@turbot/aws-config#/control/types/configurationRecorderConfigured

AWS > Config > Configuration Recorder > Discovery

Discover all AWS Config configuration recorder 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 > Config > Configuration Recorder > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-config#/control/types/configurationRecorderDiscovery

AWS > Config > Configuration Recording

Configure a custom stack on the AWS Account, per the Custom Stack > Source.
A Guardrails Stack is a set of resources configured by Guardrails, as specified
via Terraform source. Stacks are responsible for the creation and deletion
of multiple resources. Once created, stack resources are responsible for
configuring themselves from the stack source via their Configured control.

URI
tmod:@turbot/aws-config#/control/types/configurationRecordingStack

AWS > Config > Delivery Channel > Active

Take an action when an AWS Config delivery channel is not active based on the
AWS > Config > Delivery Channel > 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 > Config > Delivery Channel > 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.

URI
tmod:@turbot/aws-config#/control/types/deliveryChannelActive

AWS > Config > Delivery Channel > Approved

Take an action when an AWS Config delivery channel is not approved based on AWS > Config > Delivery Channel > 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.

URI
tmod:@turbot/aws-config#/control/types/deliveryChannelApproved

AWS > Config > Delivery Channel > CMDB

Record and synchronize details for the AWS Config delivery channel 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 > Config > Delivery Channel > Regions policy, the CMDB control will delete the resource from the CMDB. (Note: Setting CMDB to Skip will also pause these changes.)

URI
tmod:@turbot/aws-config#/control/types/deliveryChannelCmdb
Category

AWS > Config > Delivery Channel > Configured

Maintain AWS > Config > Delivery Channel 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

URI
tmod:@turbot/aws-config#/control/types/deliveryChannelConfigured

AWS > Config > Delivery Channel > Discovery

Discover all AWS Config delivery channel 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 > Config > Delivery Channel > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-config#/control/types/deliveryChannelDiscovery

AWS > Config > Rule > Active

Take an action when an AWS Config rule is not active based on the
AWS > Config > Rule > 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 > Config > Rule > 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.

URI
tmod:@turbot/aws-config#/control/types/ruleActive

AWS > Config > Rule > Approved

Take an action when an AWS Config rule is not approved based on AWS > Config > Rule > 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.

URI
tmod:@turbot/aws-config#/control/types/ruleApproved

AWS > Config > Rule > CMDB

Record and synchronize details for the AWS Config rule 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 > Config > Rule > Regions policy, the CMDB control will delete the resource from the CMDB. (Note: Setting CMDB to Skip will also pause these changes.)

URI
tmod:@turbot/aws-config#/control/types/ruleCmdb
Category

AWS > Config > Rule > Discovery

Discover all AWS Config rule 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 > Config > Rule > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-config#/control/types/ruleDiscovery

AWS > Config > Rule > Tags

Take an action when an AWS Config rule tags is not updated based on the AWS > Config > Rule > Tags > * policies.

If the resource is not updated with the tags defined in AWS > Config > Rule > Tags > Template, this control raises an alarm and takes the defined enforcement action.

See Tags for more information.

URI
tmod:@turbot/aws-config#/control/types/ruleTags

AWS > Config > Rule > Usage

The Usage control determines whether the number of AWS Config rule resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > Config > Rule > Usage policy, and set the limit with the AWS > Config > Rule > Usage > Limit policy.

URI
tmod:@turbot/aws-config#/control/types/ruleUsage