Control types for @turbot/aws-batch

AWS > Batch > Compute Environment > Active

Take an action when an AWS Batch compute environment is not active based on the
AWS > Batch > Compute Environment > 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 > Batch > Compute Environment > 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-batch#/control/types/computeEnvironmentActive

AWS > Batch > Compute Environment > Approved

Take an action when an AWS Batch compute environment is not approved based on AWS > Batch > Compute Environment > 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-batch#/control/types/computeEnvironmentApproved

AWS > Batch > Compute Environment > CMDB

Record and synchronize details for the AWS Batch compute environment 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 > Batch > Compute Environment > 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-batch#/control/types/computeEnvironmentCmdb
Category

AWS > Batch > Compute Environment > Discovery

Discover all AWS Batch compute environment 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 > Batch > Compute Environment > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-batch#/control/types/computeEnvironmentDiscovery

AWS > Batch > Compute Environment > Tags

Take an action when an AWS Batch compute environment tags is not updated based on the AWS > Batch > Compute Environment > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-batch#/control/types/computeEnvironmentTags

AWS > Batch > Compute Environment > Usage

The Usage control determines whether the number of AWS Batch compute environment resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > Batch > Compute Environment > Usage policy, and set the limit with the AWS > Batch > Compute Environment > Usage > Limit policy.

URI
tmod:@turbot/aws-batch#/control/types/computeEnvironmentUsage

AWS > Batch > Job Definition > Active

Take an action when an AWS Batch job definition is not active based on the
AWS > Batch > Job Definition > 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 > Batch > Job Definition > 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-batch#/control/types/jobDefinitionActive

AWS > Batch > Job Definition > Approved

Take an action when an AWS Batch job definition is not approved based on AWS > Batch > Job Definition > 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-batch#/control/types/jobDefinitionApproved

AWS > Batch > Job Definition > CMDB

Record and synchronize details for the AWS Batch job definition 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 > Batch > Job Definition > 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-batch#/control/types/jobDefinitionCmdb
Category

AWS > Batch > Job Definition > Discovery

Discover all AWS Batch job definition 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 > Batch > Job Definition > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-batch#/control/types/jobDefinitionDiscovery

AWS > Batch > Job Definition > Usage

The Usage control determines whether the number of AWS Batch job definition resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > Batch > Job Definition > Usage policy, and set the limit with the AWS > Batch > Job Definition > Usage > Limit policy.

URI
tmod:@turbot/aws-batch#/control/types/jobDefinitionUsage

AWS > Batch > Job Queue > Active

Take an action when an AWS Batch job queue is not active based on the
AWS > Batch > Job Queue > 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 > Batch > Job Queue > 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-batch#/control/types/jobQueueActive

AWS > Batch > Job Queue > Approved

Take an action when an AWS Batch job queue is not approved based on AWS > Batch > Job Queue > 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-batch#/control/types/jobQueueApproved

AWS > Batch > Job Queue > CMDB

Record and synchronize details for the AWS Batch job queue 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 > Batch > Job Queue > 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-batch#/control/types/jobQueueCmdb
Category

AWS > Batch > Job Queue > Discovery

Discover all AWS Batch job queue 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 > Batch > Job Queue > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-batch#/control/types/jobQueueDiscovery

AWS > Batch > Job Queue > Tags

Take an action when an AWS Batch job queue tags is not updated based on the AWS > Batch > Job Queue > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-batch#/control/types/jobQueueTags

AWS > Batch > Job Queue > Usage

The Usage control determines whether the number of AWS Batch job queue resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > Batch > Job Queue > Usage policy, and set the limit with the AWS > Batch > Job Queue > Usage > Limit policy.

URI
tmod:@turbot/aws-batch#/control/types/jobQueueUsage