Product logo
DocsBlogPricing

Control types for @turbot/aws-backup

AWS > Backup > Backup Plan > Active

Take an action when an AWS Backup backup plan is not active based on the AWS > Backup > Backup Plan > 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 > Backup > Backup Plan > 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-backup#/control/types/backupPlanActive
Parent
Category
Targets

AWS > Backup > Backup Plan > Approved

Take an action when an AWS Backup backup plan is not approved based on AWS > Backup > Backup Plan > 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-backup#/control/types/backupPlanApproved
Parent
Category
Targets

AWS > Backup > Backup Plan > CMDB

Record and synchronize details for the AWS Backup backup plan into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Turbot 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 > Backup > Backup Plan > 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-backup#/control/types/backupPlanCmdb
Parent
Category
Targets

AWS > Backup > Backup Plan > Configured

Maintain AWS > Backup > Backup Plan 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-backup#/control/types/backupPlanConfigured
Parent
Category
Targets

AWS > Backup > Backup Plan > Discovery

Discover all AWS Backup backup plan 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 > Backup > Backup Plan > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-backup#/control/types/backupPlanDiscovery
Parent
Category
Targets

AWS > Backup > Backup Plan > Tags

Take an action when an AWS Backup backup plan tags is not updated based on the AWS > Backup > Backup Plan > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-backup#/control/types/backupPlanTags
Parent
Category
Targets

AWS > Backup > Backup Plan > Usage

The Usage control determines whether the number of AWS Backup backup plan resources exceeds the configured usage limit for this account.

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

URI
tmod:@turbot/aws-backup#/control/types/backupPlanUsage
Parent
Category
Targets

AWS > Backup > Backup Selection > Active

Take an action when an AWS Backup backup selection is not active based on the AWS > Backup > Backup Selection > 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 > Backup > Backup Selection > 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-backup#/control/types/backupSelectionActive
Parent
Category
Targets

AWS > Backup > Backup Selection > Approved

Take an action when an AWS Backup backup selection is not approved based on AWS > Backup > Backup Selection > 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-backup#/control/types/backupSelectionApproved
Parent
Category
Targets

AWS > Backup > Backup Selection > CMDB

Record and synchronize details for the AWS Backup backup selection into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Turbot 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 > Backup > Backup Selection > 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-backup#/control/types/backupSelectionCmdb
Parent
Category
Targets

AWS > Backup > Backup Selection > Discovery

Discover all AWS Backup backup selection 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 > Backup > Backup Selection > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-backup#/control/types/backupSelectionDiscovery
Parent
Category
Targets

AWS > Backup > Backup Vault > Active

Take an action when an AWS Backup backup vault is not active based on the AWS > Backup > Backup Vault > 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 > Backup > Backup Vault > 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-backup#/control/types/backupVaultActive
Parent
Category
Targets

AWS > Backup > Backup Vault > Approved

Take an action when an AWS Backup backup vault is not approved based on AWS > Backup > Backup Vault > 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-backup#/control/types/backupVaultApproved
Parent
Category
Targets

AWS > Backup > Backup Vault > CMDB

Record and synchronize details for the AWS Backup backup vault into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Turbot 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 > Backup > Backup Vault > 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-backup#/control/types/backupVaultCmdb
Parent
Category
Targets

AWS > Backup > Backup Vault > Configured

Maintain AWS > Backup > Backup Vault 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-backup#/control/types/backupVaultConfigured
Parent
Category
Targets

AWS > Backup > Backup Vault > Discovery

Discover all AWS Backup backup vault 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 > Backup > Backup Vault > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-backup#/control/types/backupVaultDiscovery
Parent
Category
Targets

AWS > Backup > Backup Vault > Tags

Take an action when an AWS Backup backup vault tags is not updated based on the AWS > Backup > Backup Vault > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-backup#/control/types/backupVaultTags
Parent
Category
Targets

AWS > Backup > Backup Vault > Usage

The Usage control determines whether the number of AWS Backup backup vault resources exceeds the configured usage limit for this account.

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

URI
tmod:@turbot/aws-backup#/control/types/backupVaultUsage
Parent
Category
Targets

AWS > Backup > Protected Resource > CMDB

Record and synchronize details for the AWS Backup protected resource into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Turbot 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 > Backup > Protected Resource > 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.

URI
tmod:@turbot/aws-backup#/control/types/protectedResourceCmdb
Parent
Category
Targets

AWS > Backup > Protected Resource > Discovery

Discover all AWS Backup protected resource 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 > Backup > Protected Resource > 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 this resource type.

URI
tmod:@turbot/aws-backup#/control/types/protectedResourceDiscovery
Parent
Category
Targets

AWS > Backup > Recovery Point > Active

Take an action when an AWS Backup recovery point is not active based on the AWS > Backup > Recovery Point > 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 > Backup > Recovery Point > 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-backup#/control/types/recoveryPointActive
Parent
Category
Targets

AWS > Backup > Recovery Point > Approved

Take an action when an AWS Backup recovery point is not approved based on AWS > Backup > Recovery Point > 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-backup#/control/types/recoveryPointApproved
Parent
Category
Targets

AWS > Backup > Recovery Point > CMDB

Record and synchronize details for the AWS Backup recovery point into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Turbot 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 > Backup > Recovery Point > 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-backup#/control/types/recoveryPointCmdb
Parent
Category
Targets

AWS > Backup > Recovery Point > Discovery

Discover all AWS Backup recovery point 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 > Backup > Recovery Point > 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 this resource type.

URI
tmod:@turbot/aws-backup#/control/types/recoveryPointDiscovery
Parent
Category
Targets

AWS > Backup > Recovery Point > Tags

Take an action when an AWS Backup recovery point tags is not updated based on the AWS > Backup > Recovery Point > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-backup#/control/types/recoveryPointTags
Parent
Category
Targets

AWS > Backup > Region Settings > CMDB

Record and synchronize details for the AWS Backup region settings into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Turbot 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 > Backup > Region Settings > 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-backup#/control/types/regionSettingsCmdb
Parent
Category
Targets

AWS > Backup > Region Settings > Discovery

Discover all AWS Backup region settings 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 > Backup > Region Settings > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-backup#/control/types/regionSettingsDiscovery
Parent
Category
Targets

AWS > Backup > Region Settings > Service Opt-In

Update the current service opt-in settings for the Region. If service-opt-in is enabled for a service, AWS Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, AWS Backup does not try to protect that service's resources in this Region.

URI
tmod:@turbot/aws-backup#/control/types/regionSettingsServiceOptIn
Parent
Category
Targets

AWS > Backup > Stack

Configure a custom stack on AWS, per the custom Stack > Source.

A Turbot Stack is a set of resources configured by Turbot, 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-backup#/control/types/backupStack
Parent
Category
Targets