Product logo
DocsBlogPricing

Policy types for @turbot/gcp-bigquery

GCP > BigQuery > API Enabled

Configure whether the GCP BigQuery API is enabled.

URI
tmod:@turbot/gcp-bigquery#/policy/types/bigQueryApiEnabled
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Disabled",
  "Check: Enabled",
  "Check: Enabled if BigQuery > Enabled",
  "Enforce: Disabled",
  "Enforce: Enabled",
  "Enforce: Enabled if BigQuery > Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Disabled",
    "Check: Enabled",
    "Check: Enabled if BigQuery > Enabled",
    "Enforce: Disabled",
    "Enforce: Enabled",
    "Enforce: Enabled if BigQuery > Enabled"
  ],
  "default": "Skip"
}

GCP > BigQuery > Approved Regions [Default]

A list of GCP regions in which GCP BigQuery 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 BigQuery resources' Approved > Regions policies.

URI
tmod:@turbot/gcp-bigquery#/policy/types/bigQueryApprovedRegionsDefault
Category
Parent
Targets
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 %}"
Schema

GCP > BigQuery > CMDB

Configure whether to record and synchronize details for the GCP BigQuery bigquery into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Turbot CMDB. All policies and controls in Turbot 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 > BigQuery > BigQuery > 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-bigquery#/policy/types/bigQueryCmdb
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Enforce: Enabled",
  "Enforce: Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Enforce: Enabled",
    "Enforce: Disabled"
  ],
  "example": [
    "Skip"
  ],
  "default": "Enforce: Enabled"
}

GCP > BigQuery > Dataset > Active

Determine the action to take when an GCP BigQuery dataset, based on the GCP > BigQuery > Dataset > 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 > BigQuery > Dataset > 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-bigquery#/policy/types/datasetActive
Category
Parent
Targets
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 > BigQuery > Dataset > Active > Age

The age after which the GCP BigQuery dataset is no longer considered active. If a create time is unavailable, the time Turbot 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 > BigQuery > Dataset > 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-bigquery#/policy/types/datasetActiveAge
Category
Parent
Targets
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 > BigQuery > Dataset > Active > Last Modified

The number of days since the GCP BigQuery dataset 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 > BigQuery > Dataset > 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-bigquery#/policy/types/datasetActiveLastModified
Category
Parent
Targets
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 > BigQuery > Dataset > Approved

Determine the action to take when a GCP BigQuery dataset is not approved based on GCP > BigQuery > Dataset > 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-bigquery#/policy/types/datasetApproved
Category
Parent
Targets
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 > BigQuery > Dataset > Approved > Encryption at Rest

Define the minimum level of encryption required for GCP > BigQuery > Dataset.

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

See Approved for more information.

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

GCP > BigQuery > Dataset > 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 > BigQuery > Dataset.

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

See Approved for more information.

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

GCP > BigQuery > Dataset > Approved > Usage

Determine whether the GCP BigQuery dataset is allowed to exist.

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

See Approved for more information.

URI
tmod:@turbot/gcp-bigquery#/policy/types/datasetApprovedUsage
Category
Parent
Targets
Valid Value
[
  "Not approved",
  "Approved",
  "Approved if GCP > BigQuery > Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Not approved",
    "Approved",
    "Approved if GCP > BigQuery > Enabled"
  ],
  "example": [
    "Not approved"
  ],
  "default": "Approved if GCP > BigQuery > Enabled"
}

GCP > BigQuery > Dataset > CMDB

Configure whether to record and synchronize details for the GCP BigQuery dataset into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Turbot CMDB. All policies and controls in Turbot 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-bigquery#/policy/types/datasetCmdb
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Enforce: Enabled",
  "Enforce: Enabled if BigQuery API is enabled",
  "Enforce: Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Enforce: Enabled",
    "Enforce: Enabled if BigQuery API is enabled",
    "Enforce: Disabled"
  ],
  "example": [
    "Skip"
  ],
  "default": "Enforce: Enabled if BigQuery API is enabled"
}

GCP > BigQuery > Dataset > Labels

Determine the action to take when an GCP BigQuery dataset labels are not updated based on the GCP > BigQuery > Dataset > Labels > * policies.

The control ensure GCP BigQuery dataset labels include labels defined in GCP > BigQuery > Dataset > Labels > Template.

Labels not defined in Dataset 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-bigquery#/policy/types/datasetLabels
Category
Parent
Targets
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 > BigQuery > Dataset > Labels > Template

The template is used to generate the keys and values for GCP BigQuery dataset.

Labels not defined in Dataset 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-bigquery#/policy/types/datasetLabelsTemplate
Category
Parent
Targets
Default Template Input
[
  "{\n  project {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  defaultLabels: policyValue(uri:\"tmod:@turbot/gcp-bigquery#/policy/types/bigQueryLabelsTemplate\" 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 %}"
Schema

GCP > BigQuery > Dataset > Publicly Accessible

Ensure the BigQuery dataset is not publicly accessible.

URI
tmod:@turbot/gcp-bigquery#/policy/types/datasetPubliclyAccessible
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Dataset is not publicly accessible",
  "Enforce: Dataset is not publicly accessible"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Dataset is not publicly accessible",
    "Enforce: Dataset is not publicly accessible"
  ],
  "example": [
    "Skip"
  ],
  "default": "Skip"
}

GCP > BigQuery > Dataset > Usage

Configure the number of GCP BigQuery datasets that can be used for this project and the current consumption against the limit.

You can configure the behavior of the control with this GCP > BigQuery > Dataset > Usage policy.

URI
tmod:@turbot/gcp-bigquery#/policy/types/datasetUsage
Category
Parent
Targets
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 > BigQuery > Dataset > Usage > Limit

Maximum number of items that can be created for this project

URI
tmod:@turbot/gcp-bigquery#/policy/types/datasetUsageLimit
Category
Parent
Targets
Schema
{
  "type": "integer",
  "minimum": 0,
  "default": 100
}

GCP > BigQuery > Enabled

Enabled BigQuery.

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

GCP > BigQuery > Labels Template [Default]

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

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

URI
tmod:@turbot/gcp-bigquery#/policy/types/bigQueryLabelsTemplate
Category
Parent
Targets
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 %}"
Schema

GCP > BigQuery > Permissions

Configure whether permissions policies are in effect for GCP BigQuery. 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-bigquery#/policy/types/bigQueryPermissions
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Disabled",
  "Enabled if GCP > BigQuery > Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if GCP > BigQuery > Enabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Enabled if GCP > BigQuery > Enabled"
}

GCP > BigQuery > Permissions > Levels

Define the permissions levels that can be used to grant access to BigQuery an GCP project. Permissions levels defined will appear in the UI to assign access to Turbot 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-bigquery#/policy/types/bigQueryPermissionsLevels
Category
Parent
Targets
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 }}\n{% endfor %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "Metadata",
      "ReadOnly",
      "Operator",
      "Admin",
      "Owner"
    ]
  }
}

GCP > BigQuery > Permissions > Levels > Modifiers

A map of GCP API to Turbot Permission Level used to customize Turbot's standard permissions. You can add, remove or redefine the mapping of GCP API operations to Turbot 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

example:
  - &quot;storage.bucket.create&quot;: admin
  - &quot;sql.database.create&quot;: metadata
URI
tmod:@turbot/gcp-bigquery#/policy/types/bigQueryPermissionsLevelsModifiers
Category
Parent
Targets
Schema

GCP > BigQuery > Regions

A list of GCP regions in which GCP BigQuery 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 BigQuery resources' Regions policies.

URI
tmod:@turbot/gcp-bigquery#/policy/types/bigQueryRegionsDefault
Category
Parent
Targets
Schema
{
  "allOf": [
    {
      "$ref": "gcp#/definitions/regionNameMatcherList"
    },
    {
      "default": [
        "asia-east1",
        "asia-east2",
        "asia-northeast1",
        "asia-south1",
        "asia-southeast1",
        "australia-southeast1",
        "europe-north1",
        "europe-west2",
        "northamerica-northeast1",
        "southamerica-east1",
        "us-east4",
        "us-west2"
      ]
    }
  ]
}

GCP > BigQuery > Table > Active

Determine the action to take when an GCP BigQuery table, based on the GCP > BigQuery > Table > 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 > BigQuery > Table > 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-bigquery#/policy/types/tableActive
Category
Parent
Targets
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 > BigQuery > Table > Active > Age

The age after which the GCP BigQuery table is no longer considered active. If a create time is unavailable, the time Turbot 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 > BigQuery > Table > 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-bigquery#/policy/types/tableActiveAge
Category
Parent
Targets
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 > BigQuery > Table > Active > Last Modified

The number of days since the GCP BigQuery table 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 > BigQuery > Table > 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-bigquery#/policy/types/tableActiveLastModified
Category
Parent
Targets
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 > BigQuery > Table > Approved

Determine the action to take when a GCP BigQuery table is not approved based on GCP > BigQuery > Table > 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-bigquery#/policy/types/tableApproved
Category
Parent
Targets
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 > BigQuery > Table > Approved > Encryption at Rest

Define the minimum level of encryption required for GCP > BigQuery > Table.

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

See Approved for more information.

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

GCP > BigQuery > Table > 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 > BigQuery > Table.

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

See Approved for more information.

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

GCP > BigQuery > Table > Approved > Usage

Determine whether the GCP BigQuery table is allowed to exist.

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

See Approved for more information.

URI
tmod:@turbot/gcp-bigquery#/policy/types/tableApprovedUsage
Category
Parent
Targets
Valid Value
[
  "Not approved",
  "Approved",
  "Approved if GCP > BigQuery > Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Not approved",
    "Approved",
    "Approved if GCP > BigQuery > Enabled"
  ],
  "example": [
    "Not approved"
  ],
  "default": "Approved if GCP > BigQuery > Enabled"
}

GCP > BigQuery > Table > CMDB

Configure whether to record and synchronize details for the GCP BigQuery table into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Turbot CMDB. All policies and controls in Turbot 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-bigquery#/policy/types/tableCmdb
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Enforce: Enabled",
  "Enforce: Enabled if BigQuery API is enabled",
  "Enforce: Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Enforce: Enabled",
    "Enforce: Enabled if BigQuery API is enabled",
    "Enforce: Disabled"
  ],
  "example": [
    "Skip"
  ],
  "default": "Enforce: Enabled if BigQuery API is enabled"
}

GCP > BigQuery > Table > Labels

Determine the action to take when an GCP BigQuery table labels are not updated based on the GCP > BigQuery > Table > Labels > * policies.

The control ensure GCP BigQuery table labels include labels defined in GCP > BigQuery > Table > Labels > Template.

Labels not defined in Table 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-bigquery#/policy/types/tableLabels
Category
Parent
Targets
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 > BigQuery > Table > Labels > Template

The template is used to generate the keys and values for GCP BigQuery table.

Labels not defined in Table 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-bigquery#/policy/types/tableLabelsTemplate
Category
Parent
Targets
Default Template Input
[
  "{\n  project {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  defaultLabels: policyValue(uri:\"tmod:@turbot/gcp-bigquery#/policy/types/bigQueryLabelsTemplate\" 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 %}"
Schema

GCP > BigQuery > Table > Policy

URI
tmod:@turbot/gcp-bigquery#/policy/types/tablePolicy
Category
Parent
Targets

GCP > BigQuery > Table > Policy > Trusted Access

Check or Enforce access checking on the GCP BigQuery Table policy.

Google Cloud IAM allows you to control who has access to the bigquery table via an IAM Policy. The Trusted Access policy allows you to configure whether Turbot 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-bigquery#/policy/types/tablePolicyTrustedAccess
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Trusted Access > *",
  "Enforce: Trusted Access > *"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Trusted Access > *",
    "Enforce: Trusted Access > *"
  ],
  "default": "Skip"
}

GCP > BigQuery > Table > Policy > Trusted Access > Domains

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

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

example:
  - company.com
  - company-dev.org

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

URI
tmod:@turbot/gcp-bigquery#/policy/types/tablePolicyTrustedDomains
Category
Parent
Targets
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;\n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}

GCP > BigQuery > Table > Policy > Trusted Access > Groups

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

This policy is used by the GCP > BigQuery > Table > 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
  - &quot;*@company.com&quot;

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

URI
tmod:@turbot/gcp-bigquery#/policy/types/tablePolicyTrustedGroups
Category
Parent
Targets
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;\n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}

GCP > BigQuery > Table > Policy > Trusted Access > Service Accounts

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

This policy is used by the GCP > BigQuery > Table > 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
  - &quot;*&quot; # All service account trusted

Note: Setting the policy to an Empty array will remove all service accounts.

URI
tmod:@turbot/gcp-bigquery#/policy/types/tablePolicyTrustedServiceAccounts
Category
Parent
Targets
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;\n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}

GCP > BigQuery > Table > Policy > Trusted Access > Users

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

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

example:
  - &quot;*@company.com&quot; # All users with email ending in @company.com are trusted
  - &quot;test@dev-company.com&quot;
  - &quot;dummy@gmail.com&quot;

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

URI
tmod:@turbot/gcp-bigquery#/policy/types/tablePolicyTrustedUsers
Category
Parent
Targets
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;\n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}

GCP > BigQuery > Table > Usage

Configure the number of GCP BigQuery tables that can be used for this project and the current consumption against the limit.

You can configure the behavior of the control with this GCP > BigQuery > Table > Usage policy.

URI
tmod:@turbot/gcp-bigquery#/policy/types/tableUsage
Category
Parent
Targets
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 > BigQuery > Table > Usage > Limit

Maximum number of items that can be created for this project

URI
tmod:@turbot/gcp-bigquery#/policy/types/tableUsageLimit
Category
Parent
Targets
Schema
{
  "type": "integer",
  "minimum": 0,
  "default": 100
}

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

A GCP logs advanced filter used to specify a subset of log entries that will be forwarded by the logging sink on behalf of the gcp-bigquery mod

This is a read-only policy that is used internally by Turbot

URI
tmod:@turbot/gcp-bigquery#/policy/types/bigQueryEventPatterns
Category
Parent
Targets
Schema
{
  "type": "string",
  "default": "(resource.type = bigquery_dataset AND protoPayload.authorizationInfo.permission != bigquery.datasets.get AND protoPayload.authorizationInfo.permission != bigquery.datasets.getIamPolicy AND protoPayload.authorizationInfo.permission != bigquery.tables.get AND protoPayload.authorizationInfo.permission != bigquery.tables.getData AND protoPayload.authorizationInfo.permission != bigquery.tables.list AND severity >= INFO AND severity < ERROR)"
}

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

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

URI
tmod:@turbot/gcp-bigquery#/policy/types/gcpLevelsCompiled
Category
Parent
Targets
Schema

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

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

URI
tmod:@turbot/gcp-bigquery#/policy/types/gcpCompiledServicePermissions
Category
Parent
Targets
Schema