Control types for @turbot/gcp-sql

• GCP > SQL > API Enabled
• GCP > SQL > Backup > Active
• GCP > SQL > Backup > Approved
• GCP > SQL > Backup > CMDB
• GCP > SQL > Backup > Discovery
• GCP > SQL > Backup > Usage
• GCP > SQL > CMDB
• GCP > SQL > Database > Active
• GCP > SQL > Database > Approved
• GCP > SQL > Database > CMDB
• GCP > SQL > Database > Discovery
• GCP > SQL > Database > Usage
• GCP > SQL > Discovery
• GCP > SQL > Instance > Active
• GCP > SQL > Instance > Approved
• GCP > SQL > Instance > Backup Configuration
• GCP > SQL > Instance > Binary Log
• GCP > SQL > Instance > CMDB
• GCP > SQL > Instance > Data Protection
• GCP > SQL > Instance > Discovery
• GCP > SQL > Instance > Labels
• GCP > SQL > Instance > Usage

GCP > SQL > API Enabled

Check whether GCP SQL API is enabled.

API Enabled refers specifically to the API state of a service in a cloud project.
This control determines whether the API state is set as per desired level.

The GCP > SQL > API Enabled control compares
the API state against the API Enabled policies,
raises an alarm, and takes the defined enforcement action.

GCP > SQL > Backup > Active

Take an action when an GCP SQL backup is not active based on the
GCP > SQL > Backup > 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 (GCP > SQL > Backup > 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.

GCP > SQL > Backup > Approved

Take an action when a GCP SQL backup is not approved based on GCP > SQL > Backup > 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.

GCP > SQL > Backup > CMDB

Record and synchronize details for the GCP SQL backup into the CMDB.

The CMDB control is
responsible for populating and updating all the attributes for that
resource type in the Guardrails CMDB.

Note: If CMDB is set to Skip for a resource, then it will not be added
to the CMDB, and no controls that target it will run.

CMDB controls also use the Regions policy associated with the resource. If
region is not in GCP > SQL > Backup > Regions policy, the CMDB control will delete the
resource from the CMDB.

GCP > SQL > Backup > Discovery

Discover GCP SQL backup resources and add them to the CMDB.

The Discovery
control is tasked with identifying instances for a particular resource.
The Discovery control will periodically search for new target resources and
save them to the Guardrails 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 GCP > SQL > Backup > Regions policy, the CMDB
control will delete the resource from the CMDB.

GCP > SQL > Backup > Usage

The Usage control determines whether the number of GCP SQL backup resources exceeds the configured usage limit for this instance.

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

GCP > SQL > CMDB

Record and synchronize details for the GCP SQL into the CMDB.

The CMDB control is
responsible for populating and updating all the attributes for that
resource type in the Guardrails CMDB.

Note: If CMDB is set to Skip for a resource, then it will not be added
to the CMDB, and no controls that target it will run.

GCP > SQL > Database > Active

Take an action when an GCP SQL database is not active based on the
GCP > SQL > Database > 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 (GCP > SQL > Database > 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.

GCP > SQL > Database > Approved

Take an action when a GCP SQL database is not approved based on GCP > SQL > Database > 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.

GCP > SQL > Database > CMDB

Record and synchronize details for the GCP SQL database into the CMDB.

The CMDB control is
responsible for populating and updating all the attributes for that
resource type in the Guardrails CMDB.

Note: If CMDB is set to Skip for a resource, then it will not be added
to the CMDB, and no controls that target it will run.

CMDB controls also use the Regions policy associated with the resource. If
region is not in GCP > SQL > Database > Regions policy, the CMDB control will delete the
resource from the CMDB.

GCP > SQL > Database > Discovery

Discover GCP SQL database resources and add them to the CMDB.

The Discovery
control is tasked with identifying instances for a particular resource.
The Discovery control will periodically search for new target resources and
save them to the Guardrails 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 GCP > SQL > Database > Regions policy, the CMDB
control will delete the resource from the CMDB.

GCP > SQL > Database > Usage

The Usage control determines whether the number of GCP SQL database resources exceeds the configured usage limit for this project.

You can configure the behavior of this control with the GCP > SQL > Database > Usage policy, and set the limit with the GCP > SQL > Database > Usage > Limit policy.

GCP > SQL > Discovery

Discover GCP SQL resources and add them to the CMDB.

The Discovery
control is tasked with identifying instances for a particular resource.
The Discovery control will periodically search for new target resources and
save them to the Guardrails CMDB. Once discovered, resources are then
responsible for tracking changes to themselves through the
CMDB control.

GCP > SQL > Instance > Active

Take an action when an GCP SQL instance is not active based on the
GCP > SQL > 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 (GCP > SQL > 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.

GCP > SQL > Instance > Approved

Take an action when a GCP SQL instance is not approved based on GCP > SQL > 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.

GCP > SQL > Instance > Backup Configuration

Configure whether Backup Configuration setting is enabled for a SQL instance.

GCP > SQL > Instance > Binary Log

Configure whether Binary Log setting is enabled for a SQL instance.

GCP > SQL > Instance > CMDB

Record and synchronize details for the GCP SQL instance into the CMDB.

The CMDB control is
responsible for populating and updating all the attributes for that
resource type in the Guardrails CMDB.

Note: If CMDB is set to Skip for a resource, then it will not be added
to the CMDB, and no controls that target it will run.

CMDB controls also use the Regions policy associated with the resource. If
region is not in GCP > SQL > Instance > Regions policy, the CMDB control will delete the
resource from the CMDB.

GCP > SQL > Instance > Data Protection

Configures the automated backup feature native to GCP Cloud SQL

Backups provide a way to restore your Cloud SQL instance to recover lost data or
recover from a problem with your instance. Cloud SQL retains up to 7 automated backups
for each instance. The storage used by backups is charged at a reduced rate.

Enabling automated backups, along with binary logging, is also required for
some operations, such as clone and replica creation.

GCP > SQL > Instance > Discovery

Discover GCP SQL instance resources and add them to the CMDB.

The Discovery
control is tasked with identifying instances for a particular resource.
The Discovery control will periodically search for new target resources and
save them to the Guardrails 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 GCP > SQL > Instance > Regions policy, the CMDB
control will delete the resource from the CMDB.

GCP > SQL > Instance > Labels

Take an action when an GCP SQL instance labels is not updated based on the GCP > SQL > Instance > Labels > * policies.

If the resource is not updated with the labels defined in GCP > SQL > Instance > Labels > Template, this control raises an alarm and takes the defined enforcement action.

See Labels for more information.

GCP > SQL > Instance > Usage

The Usage control determines whether the number of GCP SQL instance resources exceeds the configured usage limit for this project.

You can configure the behavior of this control with the GCP > SQL > Instance > Usage policy, and set the limit with the GCP > SQL > Instance > Usage > Limit policy.