Policy: 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.

Resource Types

This policy targets the following resource types:

GCP > Pub/Sub > Subscription

Primary Policy

This policy is used with the following primary policy:

GCP > Pub/Sub > Subscription > Labels

Controls

GCP > Pub/Sub > Subscription > Labels

Policy Specification

Default template	`{%- if $.defaultLabels.value \| length == 0 %} [] {%- elif $.defaultLabels.value != undefined %}{{ $.defaultLabels.value \| dump \| safe }}{%- else %}{% for item in $.defaultLabels.value %}- {{ item }}{% endfor %}{% endif %}`
Default template input	`- \| { project { turbot { id } } } - \| { defaultLabels: policyValue(uri:"tmod:@turbot/gcp-pubsub#/policy/types/pubsubLabelsTemplate" resourceId: "{{ $.project.turbot.id }}") { value } }`
Examples [YAML]	`foo: bar environment: prod` `- foo123: bar - environment: dev` `- cost-center: zz123 - delete-me: undefined`

Default template

{%- if $.defaultLabels.value | length == 0 %} [] {%- elif $.defaultLabels.value != undefined %}{{ $.defaultLabels.value | dump | safe }}{%- else %}{% for item in $.defaultLabels.value %}- {{ item }}{% endfor %}{% endif %}

Default template input

- |
  {
    project {
      turbot {
        id
      }
    }
  }
- |
  {
    defaultLabels: policyValue(uri:"tmod:@turbot/gcp-pubsub#/policy/types/pubsubLabelsTemplate" resourceId: "{{ $.project.turbot.id }}") {
      value
    }
  }

Examples [YAML]

foo: bar
environment: prod

- foo123: bar
- environment: dev

- cost-center: zz123
- delete-me: undefined

In Your Workspace

Policy Settings by Type report

Developers

Category URI

tmod:@turbot/turbot#/control/categories/resourceTags

Policy Type URI

tmod:@turbot/gcp-pubsub#/policy/types/subscriptionLabelsTemplate

GraphQL

query policyType(id: "tmod:@turbot/gcp-pubsub#/policy/types/subscriptionLabelsTemplate") { … }

query policySettings(filter: "policyTypeId:'tmod:@turbot/gcp-pubsub#/policy/types/subscriptionLabelsTemplate'") { … }

query policyValues(filter: "policyTypeId:'tmod:@turbot/gcp-pubsub#/policy/types/subscriptionLabelsTemplate'") { … }

CLI

Get Policy Type

turbot graphql policy-type --id "tmod:@turbot/gcp-pubsub#/policy/types/subscriptionLabelsTemplate"

Get Policy Settings

turbot graphql policy-settings --filter "policyTypeId:tmod:@turbot/gcp-pubsub#/policy/types/subscriptionLabelsTemplate"