Policy types for @turbot/gcp-spanner

GCP > Spanner > API Enabled

Check whether GCP Spanner 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 > Spanner > 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-spanner#/policy/types/spannerApiEnabled
Valid Value
[
"Skip",
"Check: Disabled",
"Check: Enabled",
"Check: Enabled if Spanner > Enabled",
"Enforce: Disabled",
"Enforce: Enabled",
"Enforce: Enabled if Spanner > Enabled"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Disabled",
"Check: Enabled",
"Check: Enabled if Spanner > Enabled",
"Enforce: Disabled",
"Enforce: Enabled",
"Enforce: Enabled if Spanner > Enabled"
],
"default": "Skip"
}

GCP > Spanner > Approved Regions [Default]

A list of GCP regions in which GCP Spanner resources are approved for use.

The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.

This policy is the default value for all GCP Spanner resources' Approved > Regions policies.

URI
tmod:@turbot/gcp-spanner#/policy/types/spannerApprovedRegionsDefault
Default Template Input
"{\n regions: policyValue(uri:\"tmod:@turbot/gcp#/policy/types/approvedRegionsDefault\") {\n value\n }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"

GCP > Spanner > CMDB

Configure whether to record and synchronize details for the GCP Spanner spanner into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".

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".

URI
tmod:@turbot/gcp-spanner#/policy/types/spannerCmdb
Category
Valid Value
[
"Skip",
"Enforce: Enabled",
"Enforce: Disabled"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Enforce: Enabled",
"Enforce: Disabled"
],
"example": [
"Skip"
],
"default": "Enforce: Enabled"
}

GCP > Spanner > Database > Active

Determine the action to take when an GCP Spanner database, based on the GCP > Spanner > Database > Active > * policies.

The 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 > Spanner > 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.

URI
tmod:@turbot/gcp-spanner#/policy/types/databaseActive
Valid Value
[
"Skip",
"Check: Active",
"Enforce: Delete inactive with 1 day warning",
"Enforce: Delete inactive with 3 days warning",
"Enforce: Delete inactive with 7 days warning",
"Enforce: Delete inactive with 14 days warning",
"Enforce: Delete inactive with 30 days warning",
"Enforce: Delete inactive with 60 days warning",
"Enforce: Delete inactive with 90 days warning",
"Enforce: Delete inactive with 180 days warning",
"Enforce: Delete inactive with 365 days warning"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Active",
"Enforce: Delete inactive with 1 day warning",
"Enforce: Delete inactive with 3 days warning",
"Enforce: Delete inactive with 7 days warning",
"Enforce: Delete inactive with 14 days warning",
"Enforce: Delete inactive with 30 days warning",
"Enforce: Delete inactive with 60 days warning",
"Enforce: Delete inactive with 90 days warning",
"Enforce: Delete inactive with 180 days warning",
"Enforce: Delete inactive with 365 days warning"
],
"example": [
"Check: Active"
],
"default": "Skip"
}

GCP > Spanner > Database > Active > Age

The age after which the GCP Spanner database
is no longer considered active. If a create time is unavailable, the time Guardrails discovered the resource is used.

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 > Spanner > 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.

URI
tmod:@turbot/gcp-spanner#/policy/types/databaseActiveAge
Valid Value
[
"Skip",
"Force inactive if age > 1 day",
"Force inactive if age > 3 days",
"Force inactive if age > 7 days",
"Force inactive if age > 14 days",
"Force inactive if age > 30 days",
"Force inactive if age > 60 days",
"Force inactive if age > 90 days",
"Force inactive if age > 180 days",
"Force inactive if age > 365 days"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Force inactive if age > 1 day",
"Force inactive if age > 3 days",
"Force inactive if age > 7 days",
"Force inactive if age > 14 days",
"Force inactive if age > 30 days",
"Force inactive if age > 60 days",
"Force inactive if age > 90 days",
"Force inactive if age > 180 days",
"Force inactive if age > 365 days"
],
"example": [
"Force inactive if age > 90 days"
],
"default": "Skip"
}

GCP > Spanner > Database > Active > Last Modified

The number of days since the GCP Spanner database was last modified before it is considered
inactive.

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 > Spanner > 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.

URI
tmod:@turbot/gcp-spanner#/policy/types/databaseActiveLastModified
Valid Value
[
"Skip",
"Active if last modified <= 1 day",
"Active if last modified <= 3 days",
"Active if last modified <= 7 days",
"Active if last modified <= 14 days",
"Active if last modified <= 30 days",
"Active if last modified <= 60 days",
"Active if last modified <= 90 days",
"Active if last modified <= 180 days",
"Active if last modified <= 365 days",
"Force active if last modified <= 1 day",
"Force active if last modified <= 3 days",
"Force active if last modified <= 7 days",
"Force active if last modified <= 14 days",
"Force active if last modified <= 30 days",
"Force active if last modified <= 60 days",
"Force active if last modified <= 90 days",
"Force active if last modified <= 180 days",
"Force active if last modified <= 365 days"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Active if last modified <= 1 day",
"Active if last modified <= 3 days",
"Active if last modified <= 7 days",
"Active if last modified <= 14 days",
"Active if last modified <= 30 days",
"Active if last modified <= 60 days",
"Active if last modified <= 90 days",
"Active if last modified <= 180 days",
"Active if last modified <= 365 days",
"Force active if last modified <= 1 day",
"Force active if last modified <= 3 days",
"Force active if last modified <= 7 days",
"Force active if last modified <= 14 days",
"Force active if last modified <= 30 days",
"Force active if last modified <= 60 days",
"Force active if last modified <= 90 days",
"Force active if last modified <= 180 days",
"Force active if last modified <= 365 days"
],
"example": [
"Active if last modified <= 90 days"
],
"default": "Skip"
}

GCP > Spanner > Database > Approved

Determine the action to take when a GCP Spanner database is not approved based on GCP > Spanner > 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.

URI
tmod:@turbot/gcp-spanner#/policy/types/databaseApproved
Valid Value
[
"Skip",
"Check: Approved",
"Enforce: Delete unapproved if new"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Approved",
"Enforce: Delete unapproved if new"
],
"example": [
"Check: Approved"
],
"default": "Skip"
}

GCP > Spanner > Database > Approved > Custom

Determine whether the GCP Spanner database is allowed to exist.
This policy will be evaluated by the Approved control. If a GCP Spanner database is not approved, it will be subject to the action specified in the GCP > Spanner > Database > Approved policy.
See Approved for more information.

Note: The policy value must be a string with a value of Approved, Not approved or Skip, or in the form of YAML objects. The object(s) must contain the key result with its value as Approved or Not approved. A custom title and message can also be added using the keys title and message respectively.

URI
tmod:@turbot/gcp-spanner#/policy/types/databaseApprovedCustom
Schema
{
"example": [
"Approved",
"Not approved",
"Skip",
{
"result": "Approved"
},
{
"title": "string",
"result": "Not approved"
},
{
"title": "string",
"result": "Approved",
"message": "string"
},
[
{
"title": "string",
"result": "Approved",
"message": "string"
},
{
"title": "string",
"result": "Not approved",
"message": "string"
}
]
],
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"pattern": "^[\\W\\w]{1,32}$"
},
"message": {
"type": "string",
"pattern": "^[\\W\\w]{1,128}$"
},
"result": {
"type": "string",
"pattern": "^(Approved|Not approved|Skip)$"
}
},
"required": [
"result"
],
"additionalProperties": false
}
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"pattern": "^[\\W\\w]{1,32}$"
},
"message": {
"type": "string",
"pattern": "^[\\W\\w]{1,128}$"
},
"result": {
"type": "string",
"pattern": "^(Approved|Not approved|Skip)$"
}
},
"required": [
"result"
],
"additionalProperties": false
},
{
"type": "string",
"pattern": "^(Approved|Not approved|Skip)$"
}
],
"default": "Skip"
}

GCP > Spanner > Database > Approved > Encryption at Rest

Define the minimum level of encryption required for GCP > Spanner > Database.

This policy will be evaluated by the Approved control. If a GCP Spanner database does not meet the minimum encryption level specified, it will be subject to the action specified in the GCP > Spanner > Database > Approved policy.

See Approved for more information.

URI
tmod:@turbot/gcp-spanner#/policy/types/databaseApprovedEncryptionAtRest
Valid Value
[
"Google managed key",
"Google managed key or higher",
"Customer managed key",
"Encryption at Rest > Customer Managed Key"
]
Schema
{
"type": "string",
"enum": [
"Google managed key",
"Google managed key or higher",
"Customer managed key",
"Encryption at Rest > Customer Managed Key"
],
"example": [
"Google managed key"
],
"default": "Google managed key or higher"
}

GCP > Spanner > Database > Approved > Encryption at Rest > Customer Managed Key

The ID of a GCP KMS symmetric key that must be used as the encryption key for a GCP > Spanner > Database.

This policy will be evaluated by the Approved control. If a GCP Spanner database is not encrypted with the specified key, it will be subject to the action specified in the GCP > Spanner > Database > Approved policy.

See Approved for more information.

URI
tmod:@turbot/gcp-spanner#/policy/types/databaseApprovedEncryptionAtRestCustomerManagedKey
Schema
{
"type": "string",
"example": "projects/my-kms-project/locations/us-east1/keyRings/my-keyring/cryptoKeys/my-key",
"default": ""
}

GCP > Spanner > Database > Approved > Regions

A list of GCP regions in which GCP Spanner databases are approved for use.

The expected format is an array of regions names. You may use the '*' and '?' wildcard characters.

This policy will be evaluated by the Approved control. If a GCP Spanner database is created in a region that is not in the approved list, it will be subject to the action specified in the GCP > Spanner > Database > Approved policy.

See Approved for more information.

URI
tmod:@turbot/gcp-spanner#/policy/types/databaseApprovedRegions
Default Template Input
"{\n regions: policyValue(uri:\"tmod:@turbot/gcp-spanner#/policy/types/spannerApprovedRegionsDefault\") {\n value\n }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"

GCP > Spanner > Database > Approved > Usage

Determine whether the GCP Spanner database is allowed to exist.

This policy will be evaluated by the Approved control. If a GCP Spanner database is not approved, it will be subject to the action specified in the GCP > Spanner > Database > Approved policy.

See Approved for more information.

URI
tmod:@turbot/gcp-spanner#/policy/types/databaseApprovedUsage
Valid Value
[
"Not approved",
"Approved",
"Approved if GCP > Spanner > Enabled"
]
Schema
{
"type": "string",
"enum": [
"Not approved",
"Approved",
"Approved if GCP > Spanner > Enabled"
],
"example": [
"Not approved"
],
"default": "Approved if GCP > Spanner > Enabled"
}

GCP > Spanner > Database > CMDB

Configure whether to record and synchronize details for the GCP Spanner database into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".

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 GCP > Spanner > Database > 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/gcp-spanner#/policy/types/databaseCmdb
Category
Valid Value
[
"Skip",
"Enforce: Enabled",
"Enforce: Disabled"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Enforce: Enabled",
"Enforce: Disabled"
],
"example": [
"Skip"
],
"default": "Enforce: Enabled"
}

GCP > Spanner > Database > Regions

A list of GCP regions in which GCP Spanner databases are supported for use.

Any databases in a region not listed here will not be recorded in CMDB.

The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.

URI
tmod:@turbot/gcp-spanner#/policy/types/databaseRegions
Default Template Input
"{\n regions: policyValue(uri:\"tmod:@turbot/gcp-spanner#/policy/types/spannerRegionsDefault\") {\n value\n }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"

GCP > Spanner > Database > Usage

Configure the number of GCP Spanner databases that can be used for this instance and the current consumption against the limit.

You can configure the behavior of the control with this GCP > Spanner > Database > Usage policy.

URI
tmod:@turbot/gcp-spanner#/policy/types/databaseUsage
Valid Value
[
"Skip",
"Check: Usage <= 85% of Limit",
"Check: Usage <= 100% of Limit"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Usage <= 85% of Limit",
"Check: Usage <= 100% of Limit"
],
"example": [
"Check: Usage <= 85% of Limit"
],
"default": "Skip"
}

GCP > Spanner > Database > Usage > Limit

Maximum number of items that can be created for this instance

URI
tmod:@turbot/gcp-spanner#/policy/types/databaseUsageLimit
Schema
{
"type": "integer",
"minimum": 0,
"default": 100
}

GCP > Spanner > Enabled

Enabled Spanner.

URI
tmod:@turbot/gcp-spanner#/policy/types/spannerEnabled
Valid Value
[
"Enabled",
"Enabled: Metadata Only",
"Disabled"
]
Schema
{
"type": "string",
"enum": [
"Enabled",
"Enabled: Metadata Only",
"Disabled"
],
"example": [
"Enabled"
],
"default": "Disabled"
}

GCP > Spanner > Instance > Active

Determine the action to take when an GCP Spanner instance, based on the GCP > Spanner > Instance > Active > * policies.

The 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 > Spanner > 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/gcp-spanner#/policy/types/instanceActive
Valid Value
[
"Skip",
"Check: Active",
"Enforce: Delete inactive with 1 day warning",
"Enforce: Delete inactive with 3 days warning",
"Enforce: Delete inactive with 7 days warning",
"Enforce: Delete inactive with 14 days warning",
"Enforce: Delete inactive with 30 days warning",
"Enforce: Delete inactive with 60 days warning",
"Enforce: Delete inactive with 90 days warning",
"Enforce: Delete inactive with 180 days warning",
"Enforce: Delete inactive with 365 days warning"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Active",
"Enforce: Delete inactive with 1 day warning",
"Enforce: Delete inactive with 3 days warning",
"Enforce: Delete inactive with 7 days warning",
"Enforce: Delete inactive with 14 days warning",
"Enforce: Delete inactive with 30 days warning",
"Enforce: Delete inactive with 60 days warning",
"Enforce: Delete inactive with 90 days warning",
"Enforce: Delete inactive with 180 days warning",
"Enforce: Delete inactive with 365 days warning"
],
"example": [
"Check: Active"
],
"default": "Skip"
}

GCP > Spanner > Instance > Active > Age

The age after which the GCP Spanner instance
is no longer considered active. If a create time is unavailable, the time Guardrails discovered the resource is used.

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 > Spanner > 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/gcp-spanner#/policy/types/instanceActiveAge
Valid Value
[
"Skip",
"Force inactive if age > 1 day",
"Force inactive if age > 3 days",
"Force inactive if age > 7 days",
"Force inactive if age > 14 days",
"Force inactive if age > 30 days",
"Force inactive if age > 60 days",
"Force inactive if age > 90 days",
"Force inactive if age > 180 days",
"Force inactive if age > 365 days"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Force inactive if age > 1 day",
"Force inactive if age > 3 days",
"Force inactive if age > 7 days",
"Force inactive if age > 14 days",
"Force inactive if age > 30 days",
"Force inactive if age > 60 days",
"Force inactive if age > 90 days",
"Force inactive if age > 180 days",
"Force inactive if age > 365 days"
],
"example": [
"Force inactive if age > 90 days"
],
"default": "Skip"
}

GCP > Spanner > Instance > Active > Last Modified

The number of days since the GCP Spanner instance was last modified before it is considered
inactive.

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 > Spanner > 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.

URI
tmod:@turbot/gcp-spanner#/policy/types/instanceActiveLastModified
Valid Value
[
"Skip",
"Active if last modified <= 1 day",
"Active if last modified <= 3 days",
"Active if last modified <= 7 days",
"Active if last modified <= 14 days",
"Active if last modified <= 30 days",
"Active if last modified <= 60 days",
"Active if last modified <= 90 days",
"Active if last modified <= 180 days",
"Active if last modified <= 365 days",
"Force active if last modified <= 1 day",
"Force active if last modified <= 3 days",
"Force active if last modified <= 7 days",
"Force active if last modified <= 14 days",
"Force active if last modified <= 30 days",
"Force active if last modified <= 60 days",
"Force active if last modified <= 90 days",
"Force active if last modified <= 180 days",
"Force active if last modified <= 365 days"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Active if last modified <= 1 day",
"Active if last modified <= 3 days",
"Active if last modified <= 7 days",
"Active if last modified <= 14 days",
"Active if last modified <= 30 days",
"Active if last modified <= 60 days",
"Active if last modified <= 90 days",
"Active if last modified <= 180 days",
"Active if last modified <= 365 days",
"Force active if last modified <= 1 day",
"Force active if last modified <= 3 days",
"Force active if last modified <= 7 days",
"Force active if last modified <= 14 days",
"Force active if last modified <= 30 days",
"Force active if last modified <= 60 days",
"Force active if last modified <= 90 days",
"Force active if last modified <= 180 days",
"Force active if last modified <= 365 days"
],
"example": [
"Active if last modified <= 90 days"
],
"default": "Skip"
}

GCP > Spanner > Instance > Approved

Determine the action to take when a GCP Spanner instance is not approved based on GCP > Spanner > 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/gcp-spanner#/policy/types/instanceApproved
Valid Value
[
"Skip",
"Check: Approved",
"Enforce: Delete unapproved if new"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Approved",
"Enforce: Delete unapproved if new"
],
"example": [
"Check: Approved"
],
"default": "Skip"
}

GCP > Spanner > Instance > Approved > Custom

Determine whether the GCP Spanner instance is allowed to exist.
This policy will be evaluated by the Approved control. If a GCP Spanner instance is not approved, it will be subject to the action specified in the GCP > Spanner > Instance > Approved policy.
See Approved for more information.

Note: The policy value must be a string with a value of Approved, Not approved or Skip, or in the form of YAML objects. The object(s) must contain the key result with its value as Approved or Not approved. A custom title and message can also be added using the keys title and message respectively.

URI
tmod:@turbot/gcp-spanner#/policy/types/instanceApprovedCustom
Schema
{
"example": [
"Approved",
"Not approved",
"Skip",
{
"result": "Approved"
},
{
"title": "string",
"result": "Not approved"
},
{
"title": "string",
"result": "Approved",
"message": "string"
},
[
{
"title": "string",
"result": "Approved",
"message": "string"
},
{
"title": "string",
"result": "Not approved",
"message": "string"
}
]
],
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"pattern": "^[\\W\\w]{1,32}$"
},
"message": {
"type": "string",
"pattern": "^[\\W\\w]{1,128}$"
},
"result": {
"type": "string",
"pattern": "^(Approved|Not approved|Skip)$"
}
},
"required": [
"result"
],
"additionalProperties": false
}
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"pattern": "^[\\W\\w]{1,32}$"
},
"message": {
"type": "string",
"pattern": "^[\\W\\w]{1,128}$"
},
"result": {
"type": "string",
"pattern": "^(Approved|Not approved|Skip)$"
}
},
"required": [
"result"
],
"additionalProperties": false
},
{
"type": "string",
"pattern": "^(Approved|Not approved|Skip)$"
}
],
"default": "Skip"
}

GCP > Spanner > Instance > Approved > Regions

A list of GCP regions in which GCP Spanner instances are approved for use.

The expected format is an array of regions names. You may use the '*' and '?' wildcard characters.

This policy will be evaluated by the Approved control. If a GCP Spanner instance is created in a region that is not in the approved list, it will be subject to the action specified in the GCP > Spanner > Instance > Approved policy.

See Approved for more information.

URI
tmod:@turbot/gcp-spanner#/policy/types/instanceApprovedRegions
Default Template Input
"{\n regions: policyValue(uri:\"tmod:@turbot/gcp-spanner#/policy/types/spannerApprovedRegionsDefault\") {\n value\n }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"

GCP > Spanner > Instance > Approved > Usage

Determine whether the GCP Spanner instance is allowed to exist.

This policy will be evaluated by the Approved control. If a GCP Spanner instance is not approved, it will be subject to the action specified in the GCP > Spanner > Instance > Approved policy.

See Approved for more information.

URI
tmod:@turbot/gcp-spanner#/policy/types/instanceApprovedUsage
Valid Value
[
"Not approved",
"Approved",
"Approved if GCP > Spanner > Enabled"
]
Schema
{
"type": "string",
"enum": [
"Not approved",
"Approved",
"Approved if GCP > Spanner > Enabled"
],
"example": [
"Not approved"
],
"default": "Approved if GCP > Spanner > Enabled"
}

GCP > Spanner > Instance > CMDB

Configure whether to record and synchronize details for the GCP Spanner instance into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".

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 GCP > Spanner > 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/gcp-spanner#/policy/types/instanceCmdb
Category
Valid Value
[
"Skip",
"Enforce: Enabled",
"Enforce: Enabled if Spanner API is enabled",
"Enforce: Disabled"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Enforce: Enabled",
"Enforce: Enabled if Spanner API is enabled",
"Enforce: Disabled"
],
"example": [
"Skip"
],
"default": "Enforce: Enabled if Spanner API is enabled"
}

GCP > Spanner > Instance > Labels

Determine the action to take when an GCP Spanner instance labels are not updated based on the GCP > Spanner > Instance > Labels > * policies.

The control ensure GCP Spanner instance labels include labels defined in GCP > Spanner > Instance > Labels > Template.

Labels not defined in Instance Labels Template will not be modified or deleted. Setting a label value to undefined will result in the label being deleted.

See Labels for more information.

URI
tmod:@turbot/gcp-spanner#/policy/types/instanceLabels
Valid Value
[
"Skip",
"Check: Labels are correct",
"Enforce: Set labels"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Labels are correct",
"Enforce: Set labels"
],
"example": [
"Check: Labels are correct"
],
"default": "Skip"
}

GCP > Spanner > Instance > Labels > Template

The template is used to generate the keys and values for GCP Spanner instance.

Labels not defined in Instance Labels Template will not be modified or deleted. Setting a label value to undefined will result in the label being deleted.

See Labels for more information.

URI
tmod:@turbot/gcp-spanner#/policy/types/instanceLabelsTemplate
Default Template Input
[
"{\n project {\n turbot {\n id\n }\n }\n}\n",
"{\n defaultLabels: policyValue(uri:\"tmod:@turbot/gcp-spanner#/policy/types/spannerLabelsTemplate\" resourceId: \"{{ $.project.turbot.id }}\") {\n value\n }\n}\n"
]
Default Template
"{%- if $.defaultLabels.value | length == 0 %} [] {%- elif $.defaultLabels.value != undefined %}{{ $.defaultLabels.value | dump | safe }}{%- else %}{% for item in $.defaultLabels.value %}- {{ item }}{% endfor %}{% endif %}"

GCP > Spanner > Instance > Policy

URI
tmod:@turbot/gcp-spanner#/policy/types/instancePolicy
Targets

GCP > Spanner > Instance > Policy > Trusted Access

Check or Enforce access checking on the GCP Spanner Instance policy.

Google Cloud IAM allows you to control who has access to the
spanner instance via an IAM Policy. The Trusted Access policy
allows you to configure whether Guardrails will evaluate or
enforce restrictions on which members are allowed to be granted
access.

If enabled, the members in the IAM policy will be evaluated
against the list of allowed members in each of the Trusted
Access sub-policies (Trusted Access > Domains,
Trusted Access > Groups, etc).

If set to "Enforce: Trusted Access > *", access to non-trusted
members will be removed.

URI
tmod:@turbot/gcp-spanner#/policy/types/instancePolicyTrustedAccess
Valid Value
[
"Skip",
"Check: Trusted Access > *",
"Enforce: Trusted Access > *"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Trusted Access > *",
"Enforce: Trusted Access > *"
],
"default": "Skip"
}

GCP > Spanner > Instance > Policy > Trusted Access > Domains

List of GCP Domains that are trusted for access in the GCP Spanner Instance policy.

This policy is used by the GCP > Spanner > Instance > Policy > Trusted Access
control to determine which members of type "domain" are allowed
to be granted access.You may use the '*' and '?' wildcard characters.

<br />example:<br /> - company.com<br /> - company-dev.org<br />

Note: Setting the policy to Empty array will remove all domains.

URI
tmod:@turbot/gcp-spanner#/policy/types/instancePolicyTrustedDomains
Default Template Input
"{\n value: policy(uri: \"tmod:@turbot/gcp-spanner#/policy/types/spannerTrustedDomains\")\n}\n"
Default Template
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}{% endif %}"
Schema
{
"type": "array",
"items": {
"type": "string"
}
}

GCP > Spanner > Instance > Policy > Trusted Access > Groups

List of GCP Groups that are trusted for access in the GCP Spanner Instance policy.

This policy is used by the GCP > Spanner > Instance > Policy > Trusted Access
control to determine which members of type "group" are allowed
to be granted access.You may use the '' and '?' wildcard characters.

```
example:
- notification@company.com
- "
@company.com"
``<br /><br />**Note**: Setting the policy to an Empty` array will remove all groups.

URI
tmod:@turbot/gcp-spanner#/policy/types/instancePolicyTrustedGroups
Default Template Input
"{\n value: policy(uri: \"tmod:@turbot/gcp-spanner#/policy/types/spannerTrustedGroups\")\n}\n"
Default Template
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}{% endif %}"
Schema
{
"type": "array",
"items": {
"type": "string"
}
}

GCP > Spanner > Instance > Policy > Trusted Access > Projects

List of GCP Projects that are trusted for access in the GCP Spanner Instance policy.
This policy is used by the GCP > Spanner > Instance > Policy > Trusted Access
control to determine whether members of type "project" are allowed
to be granted access.You may use the '*' and '?' wildcard characters.
<br />example:<br /> - dev-aaa<br /> - dev-aab<br />
Note: Setting the policy to an Empty array will remove all projects.

URI
tmod:@turbot/gcp-spanner#/policy/types/instancePolicyTrustedProjects
Default Template Input
"{\n value: policy(uri: \"tmod:@turbot/gcp-spanner#/policy/types/spannerTrustedProjects\")\n}\n"
Default Template
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}{% endif %}"
Schema
{
"type": "array",
"items": {
"type": "string"
}
}

GCP > Spanner > Instance > Policy > Trusted Access > Service Accounts

List of GCP Service Accounts that are trusted for access in the GCP Spanner Instance policy.

This policy is used by the GCP > Spanner > Instance > Policy > Trusted Access
control to determine which members of type "serviceAccount" are allowed
to be granted access.You may use the '' and '?' wildcard characters.

```
example:
- project-owner@dev-aaa.iam.gserviceaccount.com
- "
" # All service account trusted
``<br /><br />**Note**: Setting the policy to an Empty` array will remove all service accounts.

URI
tmod:@turbot/gcp-spanner#/policy/types/instancePolicyTrustedServiceAccounts
Default Template Input
"{\n value: policy(uri: \"tmod:@turbot/gcp-spanner#/policy/types/spannerTrustedServiceAccounts\")\n}\n"
Default Template
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}{% endif %}"
Schema
{
"type": "array",
"items": {
"type": "string"
}
}

GCP > Spanner > Instance > Policy > Trusted Access > Users

List of GCP Users that are trusted for access in the GCP Spanner Instance policy.

This policy is used by the GCP > Spanner > Instance > Trusted Access
control to determine which members of type "user" are allowed
to be granted access.You may use the '' and '?' wildcard characters.

```
example:
- "
@company.com" # All users with email ending in @company.com are trusted
- "test@dev-company.com"
- "dummy@gmail.com"
``<br /><br />**Note**: Setting the policy to an Empty` array will remove all users.

URI
tmod:@turbot/gcp-spanner#/policy/types/instancePolicyTrustedUsers
Default Template Input
"{\n value: policy(uri: \"tmod:@turbot/gcp-spanner#/policy/types/spannerTrustedUsers\")\n}\n"
Default Template
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}{% endif %}"
Schema
{
"type": "array",
"items": {
"type": "string"
}
}

GCP > Spanner > Instance > Regions

A list of GCP regions in which GCP Spanner instances are supported for use.

Any instances in a region not listed here will not be recorded in CMDB.

The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.

URI
tmod:@turbot/gcp-spanner#/policy/types/instanceRegions
Default Template Input
"{\n regions: policyValue(uri:\"tmod:@turbot/gcp-spanner#/policy/types/spannerRegionsDefault\") {\n value\n }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"

GCP > Spanner > Instance > Usage

Configure the number of GCP Spanner instances that can be used for this region and the current consumption against the limit.

You can configure the behavior of the control with this GCP > Spanner > Instance > Usage policy.

URI
tmod:@turbot/gcp-spanner#/policy/types/instanceUsage
Valid Value
[
"Skip",
"Check: Usage <= 85% of Limit",
"Check: Usage <= 100% of Limit"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Usage <= 85% of Limit",
"Check: Usage <= 100% of Limit"
],
"example": [
"Check: Usage <= 85% of Limit"
],
"default": "Skip"
}

GCP > Spanner > Instance > Usage > Limit

Maximum number of items that can be created for this region

URI
tmod:@turbot/gcp-spanner#/policy/types/instanceUsageLimit
Schema
{
"type": "integer",
"minimum": 0,
"default": 100
}

GCP > Spanner > Labels Template [Default]

A template used to generate the keys and values for GCP Spanner resources.

By default, all Spanner resource Labels > Template policies will use this value.

URI
tmod:@turbot/gcp-spanner#/policy/types/spannerLabelsTemplate
Default Template Input
"{\n defaultLabels: policyValue(uri:\"tmod:@turbot/gcp#/policy/types/defaultLabelsTemplate\") {\n value\n }\n}\n"
Default Template
"{%- if $.defaultLabels.value | length == 0 %} [] {%- elif $.defaultLabels.value != undefined %}{{ $.defaultLabels.value | dump | safe }}{%- else %}{% for item in $.defaultLabels.value %}- {{ item }}{% endfor %}{% endif %}"

GCP > Spanner > Permissions

Configure whether permissions policies are in effect for GCP Spanner.
This setting does not affect Project level permissions (GCP/Admin, GCP/Owner, etc).

Note: The behavior of this policy depends on the value of GCP > Permissions.

URI
tmod:@turbot/gcp-spanner#/policy/types/spannerPermissions
Valid Value
[
"Enabled",
"Disabled",
"Enabled if GCP > Spanner > Enabled"
]
Schema
{
"type": "string",
"enum": [
"Enabled",
"Disabled",
"Enabled if GCP > Spanner > Enabled"
],
"example": [
"Enabled"
],
"default": "Enabled if GCP > Spanner > Enabled"
}

GCP > Spanner > Permissions > Levels

Define the permissions levels that can be used to grant access to Spanner
an GCP project. Permissions levels defined will appear in the UI to assign access to Guardrails users.

Note: Some services do not use all permissions levels, and any permissions level that has
no permissions associated will not be created even if it is selected here.

URI
tmod:@turbot/gcp-spanner#/policy/types/spannerPermissionsLevels
Default Template Input
[
"{\n item: project {\n turbot{\n id\n }\n }\n}\n",
"{\n availableLevels: policyValues(filter:\"policyTypeLevel:self resourceId:{{ $.item.turbot.id }} policyTypeId:'tmod:@turbot/gcp-iam#/policy/types/permissionsLevelsDefault'\") {\n items {\n value\n }\n }\n}\n"
]
Default Template
"{% if $.availableLevels.items[0].value | length == 0 %} [] {% endif %}{% for item in $.availableLevels.items[0].value %}- {{ item }}&#92;n{% endfor %}"
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"Metadata",
"ReadOnly",
"Operator",
"Admin",
"Owner"
]
}
}

GCP > Spanner > Permissions > Levels > Modifiers

A map of GCP API to Guardrails Permission Level used to customize Guardrails' standard permissions.
You can add, remove or redefine the mapping of GCP API operations to Guardrails permissions levels here.

Note: Modifiers are cumulative - if you add a permission to the metadata level, it is also added
to readOnly, operator and admin. Modifier policies set here will “roll up” to the GCP level too - if
you add a permission to Admin, it will be granted to GCP/Storage/Admin and also GCP/Admin

<br />example:<br /> - &quot;storage.bucket.create&quot;: admin<br /> - &quot;sql.database.create&quot;: metadata<br />

URI
tmod:@turbot/gcp-spanner#/policy/types/spannerPermissionsLevelsModifiers

GCP > Spanner > Regions

A list of GCP regions in which GCP Spanner resources are supported for use.

The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.

This policy is the default value for all GCP Spanner resources' Regions policies.

URI
tmod:@turbot/gcp-spanner#/policy/types/spannerRegionsDefault
Schema
{
"allOf": [
{
"$ref": "gcp#/definitions/regionNameMatcherList"
},
{
"default": [
"asia-east1",
"asia-east2",
"asia-northeast1",
"asia-northeast2",
"asia-south1",
"asia-southeast1",
"australia-southeast1",
"europe-north1",
"europe-west1",
"europe-west2",
"europe-west4",
"europe-west6",
"northamerica-northeast1",
"southamerica-east1",
"us-central1",
"us-east1",
"us-east4",
"us-west1",
"us-west2"
]
}
]
}

GCP > Spanner > Trusted Domains [Default]

List of GCP Domains that are trusted for access in the GCP Spanner policy.

This policy is used by the GCP > Spanner > Policy > Trusted Access
control to determine which members of type "domain" are allowed
to be granted access.You may use the '*' and '?' wildcard characters.

<br />example:<br /> - company.com<br /> - company-dev.org<br />

Note: Setting the policy to Empty array will remove all domains.

URI
tmod:@turbot/gcp-spanner#/policy/types/spannerTrustedDomains
Default Template Input
"{\n value: policy(uri: \"tmod:@turbot/gcp#/policy/types/trustedDomains\")\n}\n"
Default Template
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}{% endif %}"
Schema
{
"type": "array",
"items": {
"type": "string"
}
}

GCP > Spanner > Trusted Groups [Default]

List of GCP Groups that are trusted for access in the GCP Spanner policy.

This policy is used by the GCP > Spanner > Policy > Trusted Access
control to determine which members of type "group" are allowed
to be granted access.You may use the '' and '?' wildcard characters.

```
example:
- notification@company.com
- "
@company.com"
``<br /><br />**Note**: Setting the policy to an Empty` array will remove all groups.

URI
tmod:@turbot/gcp-spanner#/policy/types/spannerTrustedGroups
Default Template Input
"{\n value: policy(uri: \"tmod:@turbot/gcp#/policy/types/trustedGroups\")\n}\n"
Default Template
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}{% endif %}"
Schema
{
"type": "array",
"items": {
"type": "string"
}
}

GCP > Spanner > Trusted Projects [Default]

List of GCP Projects that are trusted for access in the GCP Spanner policy.

This policy is used by the GCP > Spanner > Policy > Trusted Access
control to determine whether members of type "project" are allowed
to be granted access.You may use the '*' and '?' wildcard characters.
<br />example:<br /> - dev-aaa<br /> - dev-aab<br />
Note: Setting the policy to an Empty array will remove all projects.

URI
tmod:@turbot/gcp-spanner#/policy/types/spannerTrustedProjects
Default Template Input
"{\n value: policy(uri: \"tmod:@turbot/gcp#/policy/types/trustedProjects\")\n}\n"
Default Template
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}{% endif %}"
Schema
{
"type": "array",
"items": {
"type": "string"
}
}

GCP > Spanner > Trusted Service Accounts [Default]

List of GCP Service Accounts that are trusted for access in the GCP Spanner policy.

This policy is used by the GCP > Spanner > Policy > Trusted Access
control to determine which members of type "serviceAccount" are allowed
to be granted access.You may use the '' and '?' wildcard characters.

```
example:
- project-owner@dev-aaa.iam.gserviceaccount.com
- "
" # All service account trusted
``<br /><br />**Note**: Setting the policy to an Empty` array will remove all service accounts.

URI
tmod:@turbot/gcp-spanner#/policy/types/spannerTrustedServiceAccounts
Default Template Input
"{\n value: policy(uri: \"tmod:@turbot/gcp#/policy/types/trustedServiceAccounts\")\n}\n"
Default Template
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}{% endif %}"
Schema
{
"type": "array",
"items": {
"type": "string"
}
}

GCP > Spanner > Trusted Users [Default]

List of GCP Users that are trusted for access in the GCP Spanner policy.

This policy is used by the GCP > Spanner > Trusted Access
control to determine which members of type "user" are allowed
to be granted access.You may use the '' and '?' wildcard characters.

```
example:
- "
@company.com" # All users with email ending in @company.com are trusted
- "test@dev-company.com"
- "dummy@gmail.com"
``<br /><br />**Note**: Setting the policy to an Empty` array will remove all users.

URI
tmod:@turbot/gcp-spanner#/policy/types/spannerTrustedUsers
Default Template Input
"{\n value: policy(uri: \"tmod:@turbot/gcp#/policy/types/trustedUsers\")\n}\n"
Default Template
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}{% endif %}"
Schema
{
"type": "array",
"items": {
"type": "string"
}
}

GCP > Turbot > Event Handlers > Logging > Sink > Compiled Filter > @turbot/gcp-spanner

GCP logs advanced filter
used to specify a subset of log entries that is forwarded to the Guardrails Event Handlers
by the logging sink on behalf of GCP Spanner.

URI
tmod:@turbot/gcp-spanner#/policy/types/spannerCustomEventPatterns
Schema
{
"type": "string",
"default": "(resource.type = spanner_instance AND (protoPayload.authorizationInfo.permission = spanner.instances.create OR protoPayload.authorizationInfo.permission = spanner.instances.delete OR protoPayload.authorizationInfo.permission = spanner.instances.update OR protoPayload.authorizationInfo.permission = spanner.instances.setIamPolicy OR protoPayload.authorizationInfo.permission = spanner.databases.create OR protoPayload.authorizationInfo.permission = spanner.databases.drop OR protoPayload.authorizationInfo.permission = spanner.databases.setIamPolicy) AND severity>=INFO AND severity<ERROR)"
}

GCP > Turbot > Permissions > Compiled > Levels > @turbot/gcp-spanner

A calculated policy that Guardrails uses to create a compiled list of ALL permission
levels for GCP Spanner that is used as input to
the stack that manages the Guardrails IAM permissions objects.

URI
tmod:@turbot/gcp-spanner#/policy/types/gcpLevelsCompiled

GCP > Turbot > Permissions > Compiled > Service Permissions > @turbot/gcp-spanner

A calculated policy that Guardrails uses to create a compiled list of ALL
permissions for GCP Spanner that is used as
input to the control that manages the IAM stack.

URI
tmod:@turbot/gcp-spanner#/policy/types/gcpCompiledServicePermissions