Control types for @turbot/aws-dms

AWS > DMS > Endpoint > Active

Take an action when an AWS DMS endpoint is not active based on the
AWS > DMS > Endpoint > 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 > DMS > Endpoint > 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-dms#/control/types/endpointActive

AWS > DMS > Endpoint > Approved

Take an action when an AWS DMS endpoint is not approved based on AWS > DMS > Endpoint > 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-dms#/control/types/endpointApproved

AWS > DMS > Endpoint > CMDB

Record and synchronize details for the AWS DMS endpoint 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 > DMS > Endpoint > 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-dms#/control/types/endpointCmdb
Category

AWS > DMS > Endpoint > Configured

Maintain AWS > DMS > Endpoint 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-dms#/control/types/endpointConfigured

AWS > DMS > Endpoint > Discovery

Discover all AWS DMS endpoint 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 > DMS > Endpoint > 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-dms#/control/types/endpointDiscovery

AWS > DMS > Endpoint > Tags

Take an action when an AWS DMS endpoint tags is not updated based on the AWS > DMS > Endpoint > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-dms#/control/types/endpointTags

AWS > DMS > Endpoint > Usage

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

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

URI
tmod:@turbot/aws-dms#/control/types/endpointUsage

AWS > DMS > Replication Instance > Active

Take an action when an AWS DMS replication instance is not active based on the
AWS > DMS > Replication 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 > DMS > Replication 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-dms#/control/types/replicationInstanceActive

AWS > DMS > Replication Instance > Approved

Take an action when an AWS DMS replication instance is not approved based on AWS > DMS > Replication 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.

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-dms#/control/types/replicationInstanceApproved

AWS > DMS > Replication Instance > CMDB

Record and synchronize details for the AWS DMS replication instance 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 > DMS > Replication Instance > 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-dms#/control/types/replicationInstanceCmdb
Category

AWS > DMS > Replication Instance > Discovery

Discover all AWS DMS replication 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 > DMS > Replication Instance > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-dms#/control/types/replicationInstanceDiscovery

AWS > DMS > Replication Instance > Tags

Take an action when an AWS DMS replication instance tags is not updated based on the AWS > DMS > Replication Instance > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-dms#/control/types/replicationInstanceTags

AWS > DMS > Replication Instance > Usage

The Usage control determines whether the number of AWS DMS replication instance resources exceeds the configured usage limit for this region.

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

URI
tmod:@turbot/aws-dms#/control/types/replicationInstanceUsage