Control types for @turbot/aws-docdb

AWS > Doc DB > DB Cluster > Active

Take an action when an AWS DocDB db cluster is not active based on the AWS > DocDB > DB Cluster > 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 > DocDB > DB Cluster > 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-docdb#/control/types/dbClusterActive

AWS > Doc DB > DB Cluster > Approved

Take an action when an AWS DocDB db cluster is not approved based on AWS > DocDB > DB Cluster > 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.

See Approved for more information.

URI
tmod:@turbot/aws-docdb#/control/types/dbClusterApproved

AWS > Doc DB > DB Cluster > CMDB

Record and synchronize details for the AWS Doc DB db cluster 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 > Doc DB > DB Cluster > 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-docdb#/control/types/dbClusterCmdb
Category

AWS > Doc DB > DB Cluster > Discovery

Discover all AWS Doc DB db cluster 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 > Doc DB > DB Cluster > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-docdb#/control/types/dbClusterDiscovery

AWS > Doc DB > DB Cluster > Tags

Take an action when an AWS Doc DB db cluster tags is not updated based on the AWS > Doc DB > DB Cluster > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-docdb#/control/types/dbClusterTags

AWS > Doc DB > DB Cluster > Usage

The Usage control determines whether the number of AWS Doc DB db cluster resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > Doc DB > DB Cluster > Usage policy, and set the limit with the AWS > Doc DB > DB Cluster > Usage > Limit policy.

URI
tmod:@turbot/aws-docdb#/control/types/dbClusterUsage

AWS > Doc DB > DB Cluster Parameter Group > Active

Take an action when an AWS DocDB db cluster parameter group is not active based on the AWS > DocDB > DB Cluster Parameter Group > 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 > DocDB > DB Cluster Parameter Group > 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-docdb#/control/types/dbClusterParameterGroupActive

AWS > Doc DB > DB Cluster Parameter Group > Approved

Take an action when an AWS DocDB db cluster parameter group is not approved based on AWS > DocDB > DB Cluster Parameter Group > 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.

See Approved for more information.

URI
tmod:@turbot/aws-docdb#/control/types/dbClusterParameterGroupApproved

AWS > Doc DB > DB Cluster Parameter Group > CMDB

Record and synchronize details for the AWS Doc DB db cluster parameter group 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 > Doc DB > DB Cluster Parameter Group > 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-docdb#/control/types/dbClusterParameterGroupCmdb
Category

AWS > Doc DB > DB Cluster Parameter Group > Discovery

Discover all AWS Doc DB db cluster parameter group 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 > Doc DB > DB Cluster Parameter Group > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-docdb#/control/types/dbClusterParameterGroupDiscovery

AWS > Doc DB > DB Cluster Parameter Group > Tags

Take an action when an AWS Doc DB db cluster parameter group tags is not updated based on the AWS > Doc DB > DB Cluster Parameter Group > Tags > * policies.

If the resource is not updated with the tags defined in AWS > Doc DB > DB Cluster Parameter Group > Tags > Template, this control raises an alarm and takes the defined enforcement action.

See Tags for more information.

URI
tmod:@turbot/aws-docdb#/control/types/dbClusterParameterGroupTags

AWS > Doc DB > DB Cluster Parameter Group > Usage

The Usage control determines whether the number of AWS Doc DB db cluster parameter group resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > Doc DB > DB Cluster Parameter Group > Usage policy, and set the limit with the AWS > Doc DB > DB Cluster Parameter Group > Usage > Limit policy.

URI
tmod:@turbot/aws-docdb#/control/types/dbClusterParameterGroupUsage

AWS > Doc DB > DB Instance > Active

Take an action when an AWS DocDB db instance is not active based on the AWS > DocDB > DB Instance > 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 > DocDB > DB Instance > 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-docdb#/control/types/dbInstanceActive

AWS > Doc DB > DB Instance > Approved

Take an action when an AWS DocDB db instance is not approved based on AWS > DocDB > DB Instance > 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.

See Approved for more information.

URI
tmod:@turbot/aws-docdb#/control/types/dbInstanceApproved

AWS > Doc DB > DB Instance > CMDB

Record and synchronize details for the AWS Doc DB db instance 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 > Doc DB > DB Instance > 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-docdb#/control/types/dbInstanceCmdb
Category

AWS > Doc DB > DB Instance > Discovery

Discover all AWS Doc DB db instance 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 > Doc DB > DB Instance > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-docdb#/control/types/dbInstanceDiscovery

AWS > Doc DB > DB Instance > Tags

Take an action when an AWS Doc DB db instance tags is not updated based on the AWS > Doc DB > DB Instance > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-docdb#/control/types/dbInstanceTags

AWS > Doc DB > DB Instance > Usage

The Usage control determines whether the number of AWS Doc DB db instance resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > Doc DB > DB Instance > Usage policy, and set the limit with the AWS > Doc DB > DB Instance > Usage > Limit policy.

URI
tmod:@turbot/aws-docdb#/control/types/dbInstanceUsage