Policy: GCP > KMS > Crypto Key > Labels > Template

The template is used to generate the keys and values for GCP KMS crypto key.

Labels not defined in Crypto Key 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 > KMS > Crypto Key

Primary Policy

This policy is used with the following primary policy:

GCP > KMS > Crypto Key > Labels

Controls

GCP > KMS > Crypto Key > 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-kms#/policy/types/kmsLabelsTemplate" 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-kms#/policy/types/kmsLabelsTemplate" 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-kms#/policy/types/cryptoKeyLabelsTemplate

GraphQL

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

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

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

CLI

Get Policy Type

turbot graphql policy-type --id "tmod:@turbot/gcp-kms#/policy/types/cryptoKeyLabelsTemplate"

Get Policy Settings

turbot graphql policy-settings --filter "policyTypeId:tmod:@turbot/gcp-kms#/policy/types/cryptoKeyLabelsTemplate"