Policy types for @turbot/gcp-pubsub
- GCP > Pub/Sub > API Enabled
- GCP > Pub/Sub > CMDB
- GCP > Pub/Sub > Enabled
- GCP > Pub/Sub > Labels Template [Default]
- GCP > Pub/Sub > Permissions
- GCP > Pub/Sub > Permissions > Levels
- GCP > Pub/Sub > Permissions > Levels > Modifiers
- GCP > Pub/Sub > Snapshot > Active
- GCP > Pub/Sub > Snapshot > Active > Age
- GCP > Pub/Sub > Snapshot > Active > Last Modified
- GCP > Pub/Sub > Snapshot > Approved
- GCP > Pub/Sub > Snapshot > Approved > Custom
- GCP > Pub/Sub > Snapshot > Approved > Usage
- GCP > Pub/Sub > Snapshot > CMDB
- GCP > Pub/Sub > Snapshot > Labels
- GCP > Pub/Sub > Snapshot > Labels > Template
- GCP > Pub/Sub > Snapshot > Usage
- GCP > Pub/Sub > Snapshot > Usage > Limit
- GCP > Pub/Sub > Subscription > Active
- GCP > Pub/Sub > Subscription > Active > Age
- GCP > Pub/Sub > Subscription > Active > Last Modified
- GCP > Pub/Sub > Subscription > Approved
- GCP > Pub/Sub > Subscription > Approved > Custom
- GCP > Pub/Sub > Subscription > Approved > Usage
- GCP > Pub/Sub > Subscription > CMDB
- GCP > Pub/Sub > Subscription > Configured
- GCP > Pub/Sub > Subscription > Configured > Precedence
- GCP > Pub/Sub > Subscription > Configured > Source
- GCP > Pub/Sub > Subscription > Labels
- GCP > Pub/Sub > Subscription > Labels > Template
- GCP > Pub/Sub > Subscription > Policy
- GCP > Pub/Sub > Subscription > Policy > Trusted Access
- GCP > Pub/Sub > Subscription > Policy > Trusted Access > All Authenticated
- GCP > Pub/Sub > Subscription > Policy > Trusted Access > All Users
- GCP > Pub/Sub > Subscription > Policy > Trusted Access > Domains
- GCP > Pub/Sub > Subscription > Policy > Trusted Access > Groups
- GCP > Pub/Sub > Subscription > Policy > Trusted Access > Service Accounts
- GCP > Pub/Sub > Subscription > Policy > Trusted Access > Users
- GCP > Pub/Sub > Subscription > Usage
- GCP > Pub/Sub > Subscription > Usage > Limit
- GCP > Pub/Sub > Topic > Active
- GCP > Pub/Sub > Topic > Active > Age
- GCP > Pub/Sub > Topic > Active > Last Modified
- GCP > Pub/Sub > Topic > Approved
- GCP > Pub/Sub > Topic > Approved > Custom
- GCP > Pub/Sub > Topic > Approved > Encryption at Rest
- GCP > Pub/Sub > Topic > Approved > Encryption at Rest > Customer Managed Key
- GCP > Pub/Sub > Topic > Approved > Usage
- GCP > Pub/Sub > Topic > CMDB
- GCP > Pub/Sub > Topic > Configured
- GCP > Pub/Sub > Topic > Configured > Precedence
- GCP > Pub/Sub > Topic > Configured > Source
- GCP > Pub/Sub > Topic > Labels
- GCP > Pub/Sub > Topic > Labels > Template
- GCP > Pub/Sub > Topic > Policy
- GCP > Pub/Sub > Topic > Policy > Trusted Access
- GCP > Pub/Sub > Topic > Policy > Trusted Access > All Authenticated
- GCP > Pub/Sub > Topic > Policy > Trusted Access > All Users
- GCP > Pub/Sub > Topic > Policy > Trusted Access > Domains
- GCP > Pub/Sub > Topic > Policy > Trusted Access > Groups
- GCP > Pub/Sub > Topic > Policy > Trusted Access > Service Accounts
- GCP > Pub/Sub > Topic > Policy > Trusted Access > Users
- GCP > Pub/Sub > Topic > Usage
- GCP > Pub/Sub > Topic > Usage > Limit
- GCP > Pub/Sub > Topic IAM Member > Configured
- GCP > Pub/Sub > Topic IAM Member > Configured > Precedence
- GCP > Pub/Sub > Topic IAM Member > Configured > Source
- GCP > Pub/Sub > Trusted Domains [Default]
- GCP > Pub/Sub > Trusted Groups [Default]
- GCP > Pub/Sub > Trusted Service Accounts [Default]
- GCP > Pub/Sub > Trusted Users [Default]
- GCP > Turbot > Event Handlers > Logging > Sink > Compiled Filter > @turbot/gcp-pubsub
- GCP > Turbot > Permissions > Compiled > Levels > @turbot/gcp-pubsub
- GCP > Turbot > Permissions > Compiled > Service Permissions > @turbot/gcp-pubsub
GCP > Pub/Sub > API Enabled
Check whether GCP Pub/Sub 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 > Pub/Sub > API Enabled
control compares
the API state against the API Enabled policies,
raises an alarm, and takes the defined enforcement action.
tmod:@turbot/gcp-pubsub#/policy/types/pubsubApiEnabled
[ "Skip", "Check: Disabled", "Check: Enabled", "Check: Enabled if Pub/Sub > Enabled", "Enforce: Disabled", "Enforce: Enabled", "Enforce: Enabled if Pub/Sub > Enabled"]
{ "type": "string", "enum": [ "Skip", "Check: Disabled", "Check: Enabled", "Check: Enabled if Pub/Sub > Enabled", "Enforce: Disabled", "Enforce: Enabled", "Enforce: Enabled if Pub/Sub > Enabled" ], "default": "Skip"}
GCP > Pub/Sub > CMDB
Configure whether to record and synchronize details for the GCP Pub/Sub pub/sub 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 > Pub/Sub > Pub/Sub > Regions
policy, the CMDB control will delete the resource from the CMDB.
(Note: Setting CMDB to "Skip" will also pause these changes.)
tmod:@turbot/gcp-pubsub#/policy/types/pubsubCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
GCP > Pub/Sub > Enabled
Enabled Pub/Sub.
tmod:@turbot/gcp-pubsub#/policy/types/pubsubEnabled
[ "Enabled", "Enabled: Metadata Only", "Disabled"]
{ "type": "string", "enum": [ "Enabled", "Enabled: Metadata Only", "Disabled" ], "example": [ "Enabled" ], "default": "Disabled"}
GCP > Pub/Sub > Labels Template [Default]
A template used to generate the keys and values for GCP Pub/Sub resources.
By default, all Pub/Sub resource Labels > Template policies will use this value.
tmod:@turbot/gcp-pubsub#/policy/types/pubsubLabelsTemplate
"{\n defaultLabels: policyValue(uri:\"tmod:@turbot/gcp#/policy/types/defaultLabelsTemplate\") {\n value\n }\n}\n"
"{%- if $.defaultLabels.value | length == 0 %} [] {%- elif $.defaultLabels.value != undefined %}{{ $.defaultLabels.value | dump | safe }}{%- else %}{% for item in $.defaultLabels.value %}- {{ item }}{% endfor %}{% endif %}"
GCP > Pub/Sub > Permissions
Configure whether permissions policies are in effect for GCP Pub/Sub.
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.
tmod:@turbot/gcp-pubsub#/policy/types/pubsubPermissions
[ "Enabled", "Disabled", "Enabled if GCP > Pub/Sub > Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if GCP > Pub/Sub > Enabled" ], "example": [ "Enabled" ], "default": "Enabled if GCP > Pub/Sub > Enabled"}
GCP > Pub/Sub > Permissions > Levels
Define the permissions levels that can be used to grant access to Pub/Sub
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.
tmod:@turbot/gcp-pubsub#/policy/types/pubsubPermissionsLevels
[ "{\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"]
"{% if $.availableLevels.items[0].value | length == 0 %} [] {% endif %}{% for item in $.availableLevels.items[0].value %}- {{ item }}\n{% endfor %}"
{ "type": "array", "items": { "type": "string", "enum": [ "Metadata", "ReadOnly", "Operator", "Admin", "Owner" ] }}
GCP > Pub/Sub > 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 /> - "storage.bucket.create": admin<br /> - "sql.database.create": metadata<br />
tmod:@turbot/gcp-pubsub#/policy/types/pubsubPermissionsLevelsModifiers
GCP > Pub/Sub > Snapshot > Active
Determine the action to take when an GCP Pub/Sub snapshot, based on the GCP > Pub/Sub > Snapshot > 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 > Pub/Sub > Snapshot > 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.
tmod:@turbot/gcp-pubsub#/policy/types/snapshotActive
[ "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"]
{ "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 > Pub/Sub > Snapshot > Active > Age
The age after which the GCP Pub/Sub snapshot
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 > Pub/Sub > Snapshot > 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.
tmod:@turbot/gcp-pubsub#/policy/types/snapshotActiveAge
[ "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"]
{ "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 > Pub/Sub > Snapshot > Active > Last Modified
The number of days since the GCP Pub/Sub snapshot 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 > Pub/Sub > Snapshot > 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.
tmod:@turbot/gcp-pubsub#/policy/types/snapshotActiveLastModified
[ "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"]
{ "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 > Pub/Sub > Snapshot > Approved
Determine the action to take when a GCP Pub/Sub snapshot is not approved based on GCP > Pub/Sub > Snapshot > 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.
tmod:@turbot/gcp-pubsub#/policy/types/snapshotApproved
[ "Skip", "Check: Approved", "Enforce: Delete unapproved if new"]
{ "type": "string", "enum": [ "Skip", "Check: Approved", "Enforce: Delete unapproved if new" ], "example": [ "Check: Approved" ], "default": "Skip"}
GCP > Pub/Sub > Snapshot > Approved > Custom
Determine whether the GCP Pub/Sub snapshot is allowed to exist.
This policy will be evaluated by the Approved control. If a GCP Pub/Sub snapshot is not approved, it will be subject to the action specified in the GCP > Pub/Sub > Snapshot > 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.
tmod:@turbot/gcp-pubsub#/policy/types/snapshotApprovedCustom
{ "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 > Pub/Sub > Snapshot > Approved > Usage
Determine whether the GCP Pub/Sub snapshot is allowed to exist.
This policy will be evaluated by the Approved control. If a GCP Pub/Sub snapshot is not approved, it will be subject to the action specified in the GCP > Pub/Sub > Snapshot > Approved
policy.
See Approved for more information.
tmod:@turbot/gcp-pubsub#/policy/types/snapshotApprovedUsage
[ "Not approved", "Approved", "Approved if GCP > Pub/Sub > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if GCP > Pub/Sub > Enabled" ], "example": [ "Not approved" ], "default": "Approved if GCP > Pub/Sub > Enabled"}
GCP > Pub/Sub > Snapshot > CMDB
Configure whether to record and synchronize details for the GCP Pub/Sub snapshot 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".
tmod:@turbot/gcp-pubsub#/policy/types/snapshotCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Enabled if Pub/Sub API is enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Enabled if Pub/Sub API is enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled if Pub/Sub API is enabled"}
GCP > Pub/Sub > Snapshot > Labels
Determine the action to take when an GCP Pub/Sub snapshot labels are not updated based on the GCP > Pub/Sub > Snapshot > Labels > *
policies.
The control ensure GCP Pub/Sub snapshot labels include labels defined in GCP > Pub/Sub > Snapshot > Labels > Template
.
Labels not defined in Snapshot 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.
tmod:@turbot/gcp-pubsub#/policy/types/snapshotLabels
[ "Skip", "Check: Labels are correct", "Enforce: Set labels"]
{ "type": "string", "enum": [ "Skip", "Check: Labels are correct", "Enforce: Set labels" ], "example": [ "Check: Labels are correct" ], "default": "Skip"}
GCP > Pub/Sub > Snapshot > Labels > Template
The template is used to generate the keys and values for GCP Pub/Sub snapshot.
Labels not defined in Snapshot 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.
tmod:@turbot/gcp-pubsub#/policy/types/snapshotLabelsTemplate
[ "{\n project {\n turbot {\n id\n }\n }\n}\n", "{\n defaultLabels: policyValue(uri:\"tmod:@turbot/gcp-pubsub#/policy/types/pubsubLabelsTemplate\" resourceId: \"{{ $.project.turbot.id }}\") {\n value\n }\n}\n"]
"{%- if $.defaultLabels.value | length == 0 %} [] {%- elif $.defaultLabels.value != undefined %}{{ $.defaultLabels.value | dump | safe }}{%- else %}{% for item in $.defaultLabels.value %}- {{ item }}{% endfor %}{% endif %}"
GCP > Pub/Sub > Snapshot > Usage
Configure the number of GCP Pub/Sub snapshots 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 > Pub/Sub > Snapshot > Usage
policy.
tmod:@turbot/gcp-pubsub#/policy/types/snapshotUsage
[ "Skip", "Check: Usage <= 85% of Limit", "Check: Usage <= 100% of Limit"]
{ "type": "string", "enum": [ "Skip", "Check: Usage <= 85% of Limit", "Check: Usage <= 100% of Limit" ], "example": [ "Check: Usage <= 85% of Limit" ], "default": "Skip"}
GCP > Pub/Sub > Snapshot > Usage > Limit
Maximum number of items that can be created for this project
tmod:@turbot/gcp-pubsub#/policy/types/snapshotUsageLimit
{ "type": "integer", "minimum": 0, "default": 5000}
GCP > Pub/Sub > Subscription > Active
Determine the action to take when an GCP Pub/Sub subscription, based on the GCP > Pub/Sub > Subscription > 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 > Pub/Sub > Subscription > 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.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionActive
[ "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"]
{ "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 > Pub/Sub > Subscription > Active > Age
The age after which the GCP Pub/Sub subscription
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 > Pub/Sub > Subscription > 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.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionActiveAge
[ "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"]
{ "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 > Pub/Sub > Subscription > Active > Last Modified
The number of days since the GCP Pub/Sub subscription 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 > Pub/Sub > Subscription > 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.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionActiveLastModified
[ "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"]
{ "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 > Pub/Sub > Subscription > Approved
Determine the action to take when a GCP Pub/Sub subscription is not approved based on GCP > Pub/Sub > Subscription > 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.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionApproved
[ "Skip", "Check: Approved", "Enforce: Delete unapproved if new"]
{ "type": "string", "enum": [ "Skip", "Check: Approved", "Enforce: Delete unapproved if new" ], "example": [ "Check: Approved" ], "default": "Skip"}
GCP > Pub/Sub > Subscription > Approved > Custom
Determine whether the GCP Pub/Sub subscription is allowed to exist.
This policy will be evaluated by the Approved control. If a GCP Pub/Sub subscription is not approved, it will be subject to the action specified in the GCP > Pub/Sub > Subscription > 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.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionApprovedCustom
{ "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 > Pub/Sub > Subscription > Approved > Usage
Determine whether the GCP Pub/Sub subscription is allowed to exist.
This policy will be evaluated by the Approved control. If a GCP Pub/Sub subscription is not approved, it will be subject to the action specified in the GCP > Pub/Sub > Subscription > Approved
policy.
See Approved for more information.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionApprovedUsage
[ "Not approved", "Approved", "Approved if GCP > Pub/Sub > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if GCP > Pub/Sub > Enabled" ], "example": [ "Not approved" ], "default": "Approved if GCP > Pub/Sub > Enabled"}
GCP > Pub/Sub > Subscription > CMDB
Configure whether to record and synchronize details for the GCP Pub/Sub subscription 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".
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Enabled if Pub/Sub API is enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Enabled if Pub/Sub API is enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled if Pub/Sub API is enabled"}
GCP > Pub/Sub > Subscription > Configured
Determine how to configure this resource. Note that if the resource
is managed by another stack, then the Skip/Check/Enforce values here are ignored
and inherit from the stack that owns it
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionConfigured
[ "Skip if using Configured > Source", "Check: Configured if using Configured > Source", "Enforce: Configured if using Configured > Source"]
{ "enum": [ "Skip if using Configured > Source", "Check: Configured if using Configured > Source", "Enforce: Configured if using Configured > Source" ], "default": "Enforce: Configured if using Configured > Source"}
GCP > Pub/Sub > Subscription > Configured > Precedence
An ordered list of who is allowed to claim a resource.
A stack cannot claim a resource if it is already claimed by another
stack at a higher level of precedence.
By default, all resources are configured to use the precedence defined
here, though they can override their Claim Precedence
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionConfiguredPrecedence
{ "type": "array", "items": { "type": "string" }, "default": [ "**" ]}
GCP > Pub/Sub > Subscription > Configured > Source
A HCL or JSON format Terraform configuration source used to configure this resource
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionConfiguredSource
{ "type": "string", "default": "{\"resource\": {}}\n", "x-schema-form": { "type": "code", "language": "hcl" }}
GCP > Pub/Sub > Subscription > Labels
Determine the action to take when an GCP Pub/Sub subscription labels are not updated based on the GCP > Pub/Sub > Subscription > Labels > *
policies.
The control ensure GCP Pub/Sub subscription labels include labels defined in GCP > Pub/Sub > Subscription > Labels > Template
.
Labels not defined in Subscription 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.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionLabels
[ "Skip", "Check: Labels are correct", "Enforce: Set labels"]
{ "type": "string", "enum": [ "Skip", "Check: Labels are correct", "Enforce: Set labels" ], "example": [ "Check: Labels are correct" ], "default": "Skip"}
GCP > Pub/Sub > Subscription > Labels > Template
The template is used to generate the keys and values for GCP Pub/Sub subscription.
Labels not defined in Subscription 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.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionLabelsTemplate
[ "{\n project {\n turbot {\n id\n }\n }\n}\n", "{\n defaultLabels: policyValue(uri:\"tmod:@turbot/gcp-pubsub#/policy/types/pubsubLabelsTemplate\" resourceId: \"{{ $.project.turbot.id }}\") {\n value\n }\n}\n"]
"{%- if $.defaultLabels.value | length == 0 %} [] {%- elif $.defaultLabels.value != undefined %}{{ $.defaultLabels.value | dump | safe }}{%- else %}{% for item in $.defaultLabels.value %}- {{ item }}{% endfor %}{% endif %}"
GCP > Pub/Sub > Subscription > Policy
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionPolicy
GCP > Pub/Sub > Subscription > Policy > Trusted Access
Check or Enforce access checking on the GCP Pub/Sub Subscription policy.
Google Cloud IAM allows you to control who has access to the
pub/sub subscription 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.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionPolicyTrustedAccess
[ "Skip", "Check: Trusted Access > *", "Enforce: Trusted Access > *"]
{ "type": "string", "enum": [ "Skip", "Check: Trusted Access > *", "Enforce: Trusted Access > *" ], "default": "Skip"}
GCP > Pub/Sub > Subscription > Policy > Trusted Access > All Authenticated
Determine whether public access may be granted on GCP Pub/Sub Subscription policy.
This policy is used by the GCP > Pub/Sub > Subscription > Policy > Trusted Access
control to determine whether grants to allAuthenticatedUsers
is allowed.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionPolicyTrustedAllAuthenticated
[ "Allow allAuthenticatedUsers (Public Access)", "Do not allow allAuthenticatedUsers"]
{ "type": "string", "enum": [ "Allow allAuthenticatedUsers (Public Access)", "Do not allow allAuthenticatedUsers" ], "default": "Allow allAuthenticatedUsers (Public Access)"}
GCP > Pub/Sub > Subscription > Policy > Trusted Access > All Users
Determine whether anonymous access may be granted on GCP Pub/Sub Subscription policy.
This policy is used by the GCP > Pub/Sub > Subscription > Policy > Trusted Access
control to determine whether grants to allUsers
is allowed.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionPolicyTrustedAllUsers
[ "Allow allUsers (Anonymous Access)", "Do not allow allUsers"]
{ "type": "string", "enum": [ "Allow allUsers (Anonymous Access)", "Do not allow allUsers" ], "default": "Allow allUsers (Anonymous Access)"}
GCP > Pub/Sub > Subscription > Policy > Trusted Access > Domains
List of GCP Domains that are trusted for access in the GCP Pub/Sub Subscription policy.
This policy is used by the GCP > Pub/Sub > Subscription > 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.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionPolicyTrustedDomains
"{\n value: policy(uri: \"tmod:@turbot/gcp-pubsub#/policy/types/pubsubTrustedDomains\")\n}\n"
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
GCP > Pub/Sub > Subscription > Policy > Trusted Access > Groups
List of GCP Groups that are trusted for access in the GCP Pub/Sub Subscription policy.
This policy is used by the GCP > Pub/Sub > Subscription > 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.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionPolicyTrustedGroups
"{\n value: policy(uri: \"tmod:@turbot/gcp-pubsub#/policy/types/pubsubTrustedGroups\")\n}\n"
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
GCP > Pub/Sub > Subscription > Policy > Trusted Access > Service Accounts
List of GCP Service Accounts that are trusted for access in the GCP Pub/Sub Subscription policy.
This policy is used by the GCP > Pub/Sub > Subscription > 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.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionPolicyTrustedServiceAccounts
"{\n value: policy(uri: \"tmod:@turbot/gcp-pubsub#/policy/types/pubsubTrustedServiceAccounts\")\n}\n"
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
GCP > Pub/Sub > Subscription > Policy > Trusted Access > Users
List of GCP Users that are trusted for access in the GCP Pub/Sub Subscription policy.
This policy is used by the GCP > Pub/Sub > Subscription > 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.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionPolicyTrustedUsers
"{\n value: policy(uri: \"tmod:@turbot/gcp-pubsub#/policy/types/pubsubTrustedUsers\")\n}\n"
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
GCP > Pub/Sub > Subscription > Usage
Configure the number of GCP Pub/Sub subscriptions that can be used for this topic and the current consumption against the limit.
You can configure the behavior of the control with this GCP > Pub/Sub > Subscription > Usage
policy.
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionUsage
[ "Skip", "Check: Usage <= 85% of Limit", "Check: Usage <= 100% of Limit"]
{ "type": "string", "enum": [ "Skip", "Check: Usage <= 85% of Limit", "Check: Usage <= 100% of Limit" ], "example": [ "Check: Usage <= 85% of Limit" ], "default": "Skip"}
GCP > Pub/Sub > Subscription > Usage > Limit
Maximum number of items that can be created for this topic
tmod:@turbot/gcp-pubsub#/policy/types/subscriptionUsageLimit
{ "type": "integer", "minimum": 0, "default": 10000}
GCP > Pub/Sub > Topic > Active
Determine the action to take when an GCP Pub/Sub topic, based on the GCP > Pub/Sub > Topic > 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 > Pub/Sub > Topic > 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.
tmod:@turbot/gcp-pubsub#/policy/types/topicActive
[ "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"]
{ "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 > Pub/Sub > Topic > Active > Age
The age after which the GCP Pub/Sub topic
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 > Pub/Sub > Topic > 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.
tmod:@turbot/gcp-pubsub#/policy/types/topicActiveAge
[ "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"]
{ "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 > Pub/Sub > Topic > Active > Last Modified
The number of days since the GCP Pub/Sub topic 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 > Pub/Sub > Topic > 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.
tmod:@turbot/gcp-pubsub#/policy/types/topicActiveLastModified
[ "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"]
{ "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 > Pub/Sub > Topic > Approved
Determine the action to take when a GCP Pub/Sub topic is not approved based on GCP > Pub/Sub > Topic > 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.
tmod:@turbot/gcp-pubsub#/policy/types/topicApproved
[ "Skip", "Check: Approved", "Enforce: Delete unapproved if new"]
{ "type": "string", "enum": [ "Skip", "Check: Approved", "Enforce: Delete unapproved if new" ], "example": [ "Check: Approved" ], "default": "Skip"}
GCP > Pub/Sub > Topic > Approved > Custom
Determine whether the GCP Pub/Sub topic is allowed to exist.
This policy will be evaluated by the Approved control. If a GCP Pub/Sub topic is not approved, it will be subject to the action specified in the GCP > Pub/Sub > Topic > 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.
tmod:@turbot/gcp-pubsub#/policy/types/topicApprovedCustom
{ "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 > Pub/Sub > Topic > Approved > Encryption at Rest
Define the minimum level of encryption required for GCP > Pub/Sub > Topic.
This policy will be evaluated by the Approved control. If a GCP Pub/Sub topic does not meet the minimum encryption level specified, it will be subject to the action specified in the GCP > Pub/Sub > Topic > Approved
policy.
See Approved for more information.
tmod:@turbot/gcp-pubsub#/policy/types/topicApprovedEncryptionAtRest
[ "Google managed key", "Google managed key or higher", "Customer managed key", "Encryption at Rest > Customer Managed Key"]
{ "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 > Pub/Sub > Topic > 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 > Pub/Sub > Topic.
This policy will be evaluated by the Approved control. If a GCP Pub/Sub topic is not encrypted with the specified key, it will be subject to the action specified in the GCP > Pub/Sub > Topic > Approved
policy.
See Approved for more information.
tmod:@turbot/gcp-pubsub#/policy/types/topicApprovedEncryptionAtRestCustomerManagedKey
{ "type": "string", "example": "projects/my-kms-project/locations/us-east1/keyRings/my-keyring/cryptoKeys/my-key", "default": ""}
GCP > Pub/Sub > Topic > Approved > Usage
Determine whether the GCP Pub/Sub topic is allowed to exist.
This policy will be evaluated by the Approved control. If a GCP Pub/Sub topic is not approved, it will be subject to the action specified in the GCP > Pub/Sub > Topic > Approved
policy.
See Approved for more information.
tmod:@turbot/gcp-pubsub#/policy/types/topicApprovedUsage
[ "Not approved", "Approved", "Approved if GCP > Pub/Sub > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if GCP > Pub/Sub > Enabled" ], "example": [ "Not approved" ], "default": "Approved if GCP > Pub/Sub > Enabled"}
GCP > Pub/Sub > Topic > CMDB
Configure whether to record and synchronize details for the GCP Pub/Sub topic 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".
tmod:@turbot/gcp-pubsub#/policy/types/topicCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Enabled if Pub/Sub API is enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Enabled if Pub/Sub API is enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled if Pub/Sub API is enabled"}
GCP > Pub/Sub > Topic > Configured
Determine how to configure this resource. Note that if the resource
is managed by another stack, then the Skip/Check/Enforce values here are ignored
and inherit from the stack that owns it
tmod:@turbot/gcp-pubsub#/policy/types/topicConfigured
[ "Skip if using Configured > Source", "Check: Configured if using Configured > Source", "Enforce: Configured if using Configured > Source"]
{ "enum": [ "Skip if using Configured > Source", "Check: Configured if using Configured > Source", "Enforce: Configured if using Configured > Source" ], "default": "Enforce: Configured if using Configured > Source"}
GCP > Pub/Sub > Topic > Configured > Precedence
An ordered list of who is allowed to claim a resource.
A stack cannot claim a resource if it is already claimed by another
stack at a higher level of precedence.
By default, all resources are configured to use the precedence defined
here, though they can override their Claim Precedence
tmod:@turbot/gcp-pubsub#/policy/types/topicConfiguredPrecedence
{ "type": "array", "items": { "type": "string" }, "default": [ "**" ]}
GCP > Pub/Sub > Topic > Configured > Source
A HCL or JSON format Terraform configuration source used to configure this resource
tmod:@turbot/gcp-pubsub#/policy/types/topicConfiguredSource
{ "type": "string", "default": "{\"resource\": {}}\n", "x-schema-form": { "type": "code", "language": "hcl" }}
GCP > Pub/Sub > Topic > Labels
Determine the action to take when an GCP Pub/Sub topic labels are not updated based on the GCP > Pub/Sub > Topic > Labels > *
policies.
The control ensure GCP Pub/Sub topic labels include labels defined in GCP > Pub/Sub > Topic > Labels > Template
.
Labels not defined in Topic 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.
tmod:@turbot/gcp-pubsub#/policy/types/topicLabels
[ "Skip", "Check: Labels are correct", "Enforce: Set labels"]
{ "type": "string", "enum": [ "Skip", "Check: Labels are correct", "Enforce: Set labels" ], "example": [ "Check: Labels are correct" ], "default": "Skip"}
GCP > Pub/Sub > Topic > Labels > Template
The template is used to generate the keys and values for GCP Pub/Sub topic.
Labels not defined in Topic 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.
tmod:@turbot/gcp-pubsub#/policy/types/topicLabelsTemplate
[ "{\n project {\n turbot {\n id\n }\n }\n}\n", "{\n defaultLabels: policyValue(uri:\"tmod:@turbot/gcp-pubsub#/policy/types/pubsubLabelsTemplate\" resourceId: \"{{ $.project.turbot.id }}\") {\n value\n }\n}\n"]
"{%- if $.defaultLabels.value | length == 0 %} [] {%- elif $.defaultLabels.value != undefined %}{{ $.defaultLabels.value | dump | safe }}{%- else %}{% for item in $.defaultLabels.value %}- {{ item }}{% endfor %}{% endif %}"
GCP > Pub/Sub > Topic > Policy
tmod:@turbot/gcp-pubsub#/policy/types/topicPolicy
GCP > Pub/Sub > Topic > Policy > Trusted Access
Check or Enforce access checking on the GCP Pub/Sub Topic policy.
Google Cloud IAM allows you to control who has access to the
pub/sub topic 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.
tmod:@turbot/gcp-pubsub#/policy/types/topicPolicyTrustedAccess
[ "Skip", "Check: Trusted Access > *", "Enforce: Trusted Access > *"]
{ "type": "string", "enum": [ "Skip", "Check: Trusted Access > *", "Enforce: Trusted Access > *" ], "default": "Skip"}
GCP > Pub/Sub > Topic > Policy > Trusted Access > All Authenticated
Determine whether public access may be granted on GCP Pub/Sub Topic policy.
This policy is used by the GCP > Pub/Sub > Topic > Policy > Trusted Access
control to determine whether grants to allAuthenticatedUsers
is allowed.
tmod:@turbot/gcp-pubsub#/policy/types/topicPolicyTrustedAllAuthenticated
[ "Allow allAuthenticatedUsers (Public Access)", "Do not allow allAuthenticatedUsers"]
{ "type": "string", "enum": [ "Allow allAuthenticatedUsers (Public Access)", "Do not allow allAuthenticatedUsers" ], "default": "Allow allAuthenticatedUsers (Public Access)"}
GCP > Pub/Sub > Topic > Policy > Trusted Access > All Users
Determine whether anonymous access may be granted on GCP Pub/Sub Topic policy.
This policy is used by the GCP > Pub/Sub > Topic > Policy > Trusted Access
control to determine whether grants to allUsers
is allowed.
tmod:@turbot/gcp-pubsub#/policy/types/topicPolicyTrustedAllUsers
[ "Allow allUsers (Anonymous Access)", "Do not allow allUsers"]
{ "type": "string", "enum": [ "Allow allUsers (Anonymous Access)", "Do not allow allUsers" ], "default": "Allow allUsers (Anonymous Access)"}
GCP > Pub/Sub > Topic > Policy > Trusted Access > Domains
List of GCP Domains that are trusted for access in the GCP Pub/Sub Topic policy.
This policy is used by the GCP > Pub/Sub > Topic > 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.
tmod:@turbot/gcp-pubsub#/policy/types/topicPolicyTrustedDomains
"{\n value: policy(uri: \"tmod:@turbot/gcp-pubsub#/policy/types/pubsubTrustedDomains\")\n}\n"
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
GCP > Pub/Sub > Topic > Policy > Trusted Access > Groups
List of GCP Groups that are trusted for access in the GCP Pub/Sub Topic policy.
This policy is used by the GCP > Pub/Sub > Topic > 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.
tmod:@turbot/gcp-pubsub#/policy/types/topicPolicyTrustedGroups
"{\n value: policy(uri: \"tmod:@turbot/gcp-pubsub#/policy/types/pubsubTrustedGroups\")\n}\n"
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
GCP > Pub/Sub > Topic > Policy > Trusted Access > Service Accounts
List of GCP Service Accounts that are trusted for access in the GCP Pub/Sub Topic policy.
This policy is used by the GCP > Pub/Sub > Topic > 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.
tmod:@turbot/gcp-pubsub#/policy/types/topicPolicyTrustedServiceAccounts
"{\n value: policy(uri: \"tmod:@turbot/gcp-pubsub#/policy/types/pubsubTrustedServiceAccounts\")\n}\n"
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
GCP > Pub/Sub > Topic > Policy > Trusted Access > Users
List of GCP Users that are trusted for access in the GCP Pub/Sub Topic policy.
This policy is used by the GCP > Pub/Sub > Topic > 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.
tmod:@turbot/gcp-pubsub#/policy/types/topicPolicyTrustedUsers
"{\n value: policy(uri: \"tmod:@turbot/gcp-pubsub#/policy/types/pubsubTrustedUsers\")\n}\n"
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
GCP > Pub/Sub > Topic > Usage
Configure the number of GCP Pub/Sub topics 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 > Pub/Sub > Topic > Usage
policy.
tmod:@turbot/gcp-pubsub#/policy/types/topicUsage
[ "Skip", "Check: Usage <= 85% of Limit", "Check: Usage <= 100% of Limit"]
{ "type": "string", "enum": [ "Skip", "Check: Usage <= 85% of Limit", "Check: Usage <= 100% of Limit" ], "example": [ "Check: Usage <= 85% of Limit" ], "default": "Skip"}
GCP > Pub/Sub > Topic > Usage > Limit
Maximum number of items that can be created for this project
tmod:@turbot/gcp-pubsub#/policy/types/topicUsageLimit
{ "type": "integer", "minimum": 0, "default": 10000}
GCP > Pub/Sub > Topic IAM Member > Configured
Determine how to configure this resource. Note that if the resource
is managed by another stack, then the Skip/Check/Enforce values here are ignored
and inherit from the stack that owns it
tmod:@turbot/gcp-pubsub#/policy/types/topicIamMemberConfigured
[ "Skip if using Configured > Source", "Check: Configured if using Configured > Source", "Enforce: Configured if using Configured > Source"]
{ "enum": [ "Skip if using Configured > Source", "Check: Configured if using Configured > Source", "Enforce: Configured if using Configured > Source" ], "default": "Enforce: Configured if using Configured > Source"}
GCP > Pub/Sub > Topic IAM Member > Configured > Precedence
An ordered list of who is allowed to claim a resource.
A stack cannot claim a resource if it is already claimed by another
stack at a higher level of precedence.
By default, all resources are configured to use the precedence defined
here, though they can override their Claim Precedence
tmod:@turbot/gcp-pubsub#/policy/types/topicIamMemberConfiguredPrecedence
{ "type": "array", "items": { "type": "string" }, "default": [ "**" ]}
GCP > Pub/Sub > Topic IAM Member > Configured > Source
A HCL or JSON format Terraform configuration source used to configure this resource
tmod:@turbot/gcp-pubsub#/policy/types/topicIamMemberConfiguredSource
{ "type": "string", "default": "{\"resource\": {}}\n", "x-schema-form": { "type": "code", "language": "hcl" }}
GCP > Pub/Sub > Trusted Domains [Default]
List of GCP Domains that are trusted for access in the GCP Pub/Sub policy.
This policy is used by the GCP > Pub/Sub > 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.
tmod:@turbot/gcp-pubsub#/policy/types/pubsubTrustedDomains
"{\n value: policy(uri: \"tmod:@turbot/gcp#/policy/types/trustedDomains\")\n}\n"
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
GCP > Pub/Sub > Trusted Groups [Default]
List of GCP Groups that are trusted for access in the GCP Pub/Sub policy.
This policy is used by the GCP > Pub/Sub > 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.
tmod:@turbot/gcp-pubsub#/policy/types/pubsubTrustedGroups
"{\n value: policy(uri: \"tmod:@turbot/gcp#/policy/types/trustedGroups\")\n}\n"
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
GCP > Pub/Sub > Trusted Service Accounts [Default]
List of GCP Service Accounts that are trusted for access in the GCP Pub/Sub policy.
This policy is used by the GCP > Pub/Sub > 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.
tmod:@turbot/gcp-pubsub#/policy/types/pubsubTrustedServiceAccounts
"{\n value: policy(uri: \"tmod:@turbot/gcp#/policy/types/trustedServiceAccounts\")\n}\n"
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
GCP > Pub/Sub > Trusted Users [Default]
List of GCP Users that are trusted for access in the GCP Pub/Sub policy.
This policy is used by the GCP > Pub/Sub > 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.
tmod:@turbot/gcp-pubsub#/policy/types/pubsubTrustedUsers
"{\n value: policy(uri: \"tmod:@turbot/gcp#/policy/types/trustedUsers\")\n}\n"
"{% if $.value | length == 0 %}[]{% else %}{% for item in $.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
GCP > Turbot > Event Handlers > Logging > Sink > Compiled Filter > @turbot/gcp-pubsub
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-pubsub mod
This is a read-only policy that is used internally by Guardrails
tmod:@turbot/gcp-pubsub#/policy/types/pubsubEventPatterns
{ "type": "string", "default": "(((resource.type = pubsub_snapshot AND protoPayload.authorizationInfo.permission != pubsub.snapshots.get AND protoPayload.authorizationInfo.permission != pubsub.snapshots.getIamPolicy AND protoPayload.authorizationInfo.permission != pubsub.snapshots.list) OR (resource.type = pubsub_subscription AND protoPayload.authorizationInfo.permission != pubsub.subscriptions.get AND protoPayload.authorizationInfo.permission != pubsub.subscriptions.getIamPolicy AND protoPayload.authorizationInfo.permission != pubsub.subscriptions.list) OR (resource.type = pubsub_topic AND protoPayload.authorizationInfo.permission != pubsub.topics.get AND protoPayload.authorizationInfo.permission != pubsub.topics.getIamPolicy AND protoPayload.authorizationInfo.permission != pubsub.topics.list)) AND severity>=INFO AND severity<ERROR)"}
GCP > Turbot > Permissions > Compiled > Levels > @turbot/gcp-pubsub
A calculated policy that Guardrails uses to create a compiled list of ALL permission
levels for GCP Pub/Sub that is used as input to
the stack that manages the Guardrails IAM permissions objects.
tmod:@turbot/gcp-pubsub#/policy/types/gcpLevelsCompiled
GCP > Turbot > Permissions > Compiled > Service Permissions > @turbot/gcp-pubsub
A calculated policy that Guardrails uses to create a compiled list of ALL
permissions for GCP Pub/Sub that is used as
input to the control that manages the IAM stack.
tmod:@turbot/gcp-pubsub#/policy/types/gcpCompiledServicePermissions