Control types for @turbot/gcp-logging

GCP > Logging > API Enabled

Check whether GCP Logging 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 > Logging > API Enabled control compares
the API state against the API Enabled policies,
raises an alarm, and takes the defined enforcement action.

URI
tmod:@turbot/gcp-logging#/control/types/loggingApiEnabled

GCP > Logging > CMDB

Record and synchronize details for the GCP Logging 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.

URI
tmod:@turbot/gcp-logging#/control/types/loggingCmdb
Category

GCP > Logging > Discovery

Discover GCP Logging 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.

URI
tmod:@turbot/gcp-logging#/control/types/loggingDiscovery

GCP > Logging > Exclusion > Active

Take an action when an GCP Logging exclusion is not active based on the
GCP > Logging > Exclusion > 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 > Logging > Exclusion > 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/gcp-logging#/control/types/exclusionActive

GCP > Logging > Exclusion > Approved

Take an action when a GCP Logging exclusion is not approved based on GCP > Logging > Exclusion > 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/gcp-logging#/control/types/exclusionApproved

GCP > Logging > Exclusion > CMDB

Record and synchronize details for the GCP Logging exclusion 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.

URI
tmod:@turbot/gcp-logging#/control/types/exclusionCmdb
Category

GCP > Logging > Exclusion > Discovery

Discover GCP Logging exclusion 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.

URI
tmod:@turbot/gcp-logging#/control/types/exclusionDiscovery

GCP > Logging > Exclusion > Usage

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

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

URI
tmod:@turbot/gcp-logging#/control/types/exclusionUsage

GCP > Logging > Metric > Active

Take an action when an GCP Logging metric is not active based on the
GCP > Logging > Metric > 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 > Logging > Metric > 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/gcp-logging#/control/types/metricActive

GCP > Logging > Metric > Approved

Take an action when a GCP Logging metric is not approved based on GCP > Logging > Metric > 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/gcp-logging#/control/types/metricApproved

GCP > Logging > Metric > CMDB

Record and synchronize details for the GCP Logging metric 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.

URI
tmod:@turbot/gcp-logging#/control/types/metricCmdb
Category

GCP > Logging > Metric > Discovery

Discover GCP Logging metric 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.

URI
tmod:@turbot/gcp-logging#/control/types/metricDiscovery

GCP > Logging > Metric > Usage

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

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

URI
tmod:@turbot/gcp-logging#/control/types/metricUsage

GCP > Logging > Sink > Active

Take an action when an GCP Logging sink is not active based on the
GCP > Logging > Sink > 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 > Logging > Sink > 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/gcp-logging#/control/types/sinkActive

GCP > Logging > Sink > Approved

Take an action when a GCP Logging sink is not approved based on GCP > Logging > Sink > 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/gcp-logging#/control/types/sinkApproved

GCP > Logging > Sink > CMDB

Record and synchronize details for the GCP Logging sink 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.

URI
tmod:@turbot/gcp-logging#/control/types/sinkCmdb
Category

GCP > Logging > Sink > Configured

Maintain logging sink configuration

URI
tmod:@turbot/gcp-logging#/control/types/sinkConfigured

GCP > Logging > Sink > Discovery

Discover GCP Logging sink 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.

URI
tmod:@turbot/gcp-logging#/control/types/sinkDiscovery

GCP > Logging > Sink > Usage

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

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

URI
tmod:@turbot/gcp-logging#/control/types/sinkUsage