Product logo
DocsBlogPricing

Policy types for @turbot/gcp-kms

GCP > KMS > API Enabled

Check whether GCP KMS 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 > KMS > API Enabled control compares
the API state against the API Enabled policies,
raises an alarm, and takes the defined enforcement action.

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

GCP > KMS > Approved Regions [Default]

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

URI
tmod:@turbot/gcp-kms#/policy/types/kmsApprovedRegionsDefault
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 > KMS > CMDB

Record and synchronize details for GCP KMS Kms(s) into the CMDB.

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

GCP > KMS > Crypto Key > Approved

Determine the action to take when a GCP KMS crypto key is not approved based on GCP > KMS > Crypto Key > 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-kms#/policy/types/cryptoKeyApproved
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Approved"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Approved"
  ],
  "example": [
    "Check: Approved"
  ],
  "default": "Skip"
}

GCP > KMS > Crypto Key > Approved > Custom

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

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

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

GCP > KMS > Crypto Key > Approved > Regions

A list of GCP regions in which GCP KMS crypto keys are approved for use.

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

This policy will be evaluated by the Approved control. If a GCP KMS crypto key is created in a region that is not in the approved list, it will be subject to the action specified in the GCP > KMS > Crypto Key > Approved policy.

See Approved for more information.

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

GCP > KMS > Crypto Key > Approved > Usage

Determine whether the GCP KMS crypto key is allowed to exist.

This policy will be evaluated by the Approved control. If a GCP KMS crypto key is not approved, it will be subject to the action specified in the GCP > KMS > Crypto Key > Approved policy.

See Approved for more information.

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

GCP > KMS > Crypto Key > CMDB

Configure whether to record and synchronize details for the GCP KMS crypto key 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 > KMS > Crypto Key > 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-kms#/policy/types/cryptoKeyCmdb
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Enforce: Enabled",
  "Enforce: Enabled if KMS API is enabled",
  "Enforce: Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Enforce: Enabled",
    "Enforce: Enabled if KMS API is enabled",
    "Enforce: Disabled"
  ],
  "example": [
    "Skip"
  ],
  "default": "Enforce: Enabled if KMS API is enabled"
}

GCP > KMS > Crypto Key > Labels

Determine the action to take when an GCP KMS crypto key labels are not updated based on the GCP > KMS > Crypto Key > Labels > * policies.

The control ensure GCP KMS crypto key labels include labels defined in GCP > KMS > Crypto Key > Labels > Template.

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.

URI
tmod:@turbot/gcp-kms#/policy/types/cryptoKeyLabels
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 > 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.

URI
tmod:@turbot/gcp-kms#/policy/types/cryptoKeyLabelsTemplate
Category
Parent
Targets
Default Template Input
[
  "{\n  project {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  defaultLabels: policyValue(uri:\"tmod:@turbot/gcp-kms#/policy/types/kmsLabelsTemplate\" 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 > KMS > Crypto Key > Policy

URI
tmod:@turbot/gcp-kms#/policy/types/cryptoKeyPolicy
Category
Parent
Targets

GCP > KMS > Crypto Key > Policy > Trusted Access

Check or Enforce access checking on the GCP KMS Crypto Key policy.

Google Cloud IAM allows you to control who has access to the
kms crypto key 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-kms#/policy/types/cryptoKeyPolicyTrustedAccess
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 > KMS > Crypto Key > Policy > Trusted Access > All Authenticated

Determine whether public access may be granted on GCP KMS Crypto Key policy.
This policy is used by the GCP > KMS > Crypto Key > Policy > Trusted Access
control to determine whether grants to allAuthenticatedUsers is allowed.

URI
tmod:@turbot/gcp-kms#/policy/types/cryptoKeyPolicyTrustedAllAuthenticated
Category
Parent
Targets
Valid Value
[
  "Allow allAuthenticatedUsers (Public Access)",
  "Do not allow allAuthenticatedUsers"
]
Schema
{
  "type": "string",
  "enum": [
    "Allow allAuthenticatedUsers (Public Access)",
    "Do not allow allAuthenticatedUsers"
  ],
  "default": "Allow allAuthenticatedUsers (Public Access)"
}

GCP > KMS > Crypto Key > Policy > Trusted Access > All Users

Determine whether anonymous access may be granted on GCP KMS Crypto Key policy.
This policy is used by the GCP > KMS > Crypto Key > Policy > Trusted Access
control to determine whether grants to allUsers is allowed.

URI
tmod:@turbot/gcp-kms#/policy/types/cryptoKeyPolicyTrustedAllUsers
Category
Parent
Targets
Valid Value
[
  "Allow allUsers (Anonymous Access)",
  "Do not allow allUsers"
]
Schema
{
  "type": "string",
  "enum": [
    "Allow allUsers (Anonymous Access)",
    "Do not allow allUsers"
  ],
  "default": "Allow allUsers (Anonymous Access)"
}

GCP > KMS > Crypto Key > Policy > Trusted Access > Domains

List of GCP Domains that are trusted for access in the GCP KMS Crypto Key policy.

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

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

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

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

GCP > KMS > Crypto Key > Policy > Trusted Access > Groups

List of GCP Groups that are trusted for access in the GCP KMS Crypto Key policy.

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

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

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

GCP > KMS > Crypto Key > Policy > Trusted Access > Service Accounts

List of GCP Service Accounts that are trusted for access in the GCP KMS Crypto Key policy.

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

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

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

GCP > KMS > Crypto Key > Policy > Trusted Access > Users

List of GCP Users that are trusted for access in the GCP KMS Crypto Key policy.

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

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

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

GCP > KMS > Crypto Key > Regions

A list of GCP regions in which GCP KMS crypto keys are supported for use.

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

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

URI
tmod:@turbot/gcp-kms#/policy/types/cryptoKeyRegions
Category
Parent
Targets
Schema
{
  "allOf": [
    {
      "$ref": "gcp#/definitions/regionNameMatcherList"
    },
    {
      "default": [
        "asia",
        "asia-east1",
        "asia-east2",
        "asia-northeast1",
        "asia-northeast2",
        "asia-south1",
        "asia-southeast1",
        "australia-southeast1",
        "eur4",
        "europe",
        "europe-north1",
        "europe-west1",
        "europe-west2",
        "europe-west3",
        "europe-west4",
        "europe-west6",
        "global",
        "nam4",
        "northamerica-northeast1",
        "southamerica-east1",
        "us",
        "us-central1",
        "us-east1",
        "us-east4",
        "us-west1",
        "us-west2"
      ]
    }
  ]
}

GCP > KMS > Enabled

Enabled KMS.

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

GCP > KMS > Key Ring > CMDB

Configure whether to record and synchronize details for the GCP KMS key ring 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 > KMS > Key Ring > 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-kms#/policy/types/keyRingCmdb
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Enforce: Enabled",
  "Enforce: Enabled if KMS API is enabled",
  "Enforce: Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Enforce: Enabled",
    "Enforce: Enabled if KMS API is enabled",
    "Enforce: Disabled"
  ],
  "example": [
    "Skip"
  ],
  "default": "Enforce: Enabled if KMS API is enabled"
}

GCP > KMS > Key Ring > Policy

URI
tmod:@turbot/gcp-kms#/policy/types/keyRingPolicy
Category
Parent
Targets

GCP > KMS > Key Ring > Policy > Trusted Access

Check or Enforce access checking on the GCP KMS Key Ring policy.

Google Cloud IAM allows you to control who has access to the
kms key ring 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-kms#/policy/types/keyRingPolicyTrustedAccess
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 > KMS > Key Ring > Policy > Trusted Access > All Authenticated

Determine whether public access may be granted on GCP KMS Key Ring policy.
This policy is used by the GCP > KMS > Key Ring > Policy > Trusted Access
control to determine whether grants to allAuthenticatedUsers is allowed.

URI
tmod:@turbot/gcp-kms#/policy/types/keyRingPolicyTrustedAllAuthenticated
Category
Parent
Targets
Valid Value
[
  "Allow allAuthenticatedUsers (Public Access)",
  "Do not allow allAuthenticatedUsers"
]
Schema
{
  "type": "string",
  "enum": [
    "Allow allAuthenticatedUsers (Public Access)",
    "Do not allow allAuthenticatedUsers"
  ],
  "default": "Allow allAuthenticatedUsers (Public Access)"
}

GCP > KMS > Key Ring > Policy > Trusted Access > All Users

Determine whether anonymous access may be granted on GCP KMS Key Ring policy.
This policy is used by the GCP > KMS > Key Ring > Policy > Trusted Access
control to determine whether grants to allUsers is allowed.

URI
tmod:@turbot/gcp-kms#/policy/types/keyRingPolicyTrustedAllUsers
Category
Parent
Targets
Valid Value
[
  "Allow allUsers (Anonymous Access)",
  "Do not allow allUsers"
]
Schema
{
  "type": "string",
  "enum": [
    "Allow allUsers (Anonymous Access)",
    "Do not allow allUsers"
  ],
  "default": "Allow allUsers (Anonymous Access)"
}

GCP > KMS > Key Ring > Policy > Trusted Access > Domains

List of GCP Domains that are trusted for access in the GCP KMS Key Ring policy.

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

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

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

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

GCP > KMS > Key Ring > Policy > Trusted Access > Groups

List of GCP Groups that are trusted for access in the GCP KMS Key Ring policy.

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

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

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

GCP > KMS > Key Ring > Policy > Trusted Access > Service Accounts

List of GCP Service Accounts that are trusted for access in the GCP KMS Key Ring policy.

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

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

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

GCP > KMS > Key Ring > Policy > Trusted Access > Users

List of GCP Users that are trusted for access in the GCP KMS Key Ring policy.

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

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

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

GCP > KMS > Key Ring > Regions

A list of GCP regions in which GCP KMS key rings are supported for use.

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

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

URI
tmod:@turbot/gcp-kms#/policy/types/keyRingRegions
Category
Parent
Targets
Schema
{
  "allOf": [
    {
      "$ref": "gcp#/definitions/regionNameMatcherList"
    },
    {
      "default": [
        "asia",
        "asia-east1",
        "asia-east2",
        "asia-northeast1",
        "asia-northeast2",
        "asia-south1",
        "asia-southeast1",
        "australia-southeast1",
        "eur4",
        "europe",
        "europe-north1",
        "europe-west1",
        "europe-west2",
        "europe-west3",
        "europe-west4",
        "europe-west6",
        "global",
        "nam4",
        "northamerica-northeast1",
        "southamerica-east1",
        "us",
        "us-central1",
        "us-east1",
        "us-east4",
        "us-west1",
        "us-west2"
      ]
    }
  ]
}

GCP > KMS > Labels Template [Default]

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

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

URI
tmod:@turbot/gcp-kms#/policy/types/kmsLabelsTemplate
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 > KMS > Permissions

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

GCP > KMS > Permissions > Levels

Define the permissions levels that can be used to grant access to KMS
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-kms#/policy/types/kmsPermissionsLevels
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 }}&#92;n{% endfor %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "Metadata",
      "ReadOnly",
      "Operator",
      "Admin",
      "Owner"
    ]
  }
}

GCP > KMS > 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

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

URI
tmod:@turbot/gcp-kms#/policy/types/kmsPermissionsLevelsModifiers
Category
Parent
Targets
Schema

GCP > KMS > Regions

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

URI
tmod:@turbot/gcp-kms#/policy/types/kmsRegionsDefault
Category
Parent
Targets
Schema
{
  "allOf": [
    {
      "$ref": "gcp#/definitions/regionNameMatcherList"
    },
    {
      "default": [
        "asia",
        "asia-east1",
        "asia-east2",
        "asia-northeast1",
        "asia-northeast2",
        "asia-south1",
        "asia-southeast1",
        "australia-southeast1",
        "eur4",
        "europe",
        "europe-north1",
        "europe-west1",
        "europe-west2",
        "europe-west3",
        "europe-west4",
        "europe-west6",
        "global",
        "nam4",
        "northamerica-northeast1",
        "southamerica-east1",
        "us",
        "us-central1",
        "us-east1",
        "us-east4",
        "us-west1",
        "us-west2"
      ]
    }
  ]
}

GCP > KMS > Trusted Domains [Default]

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

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

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

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

URI
tmod:@turbot/gcp-kms#/policy/types/kmsTrustedDomains
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;&#92;n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}

GCP > KMS > Trusted Groups [Default]

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

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

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

URI
tmod:@turbot/gcp-kms#/policy/types/kmsTrustedGroups
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;&#92;n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}

GCP > KMS > Trusted Service Accounts [Default]

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

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

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

URI
tmod:@turbot/gcp-kms#/policy/types/kmsTrustedServiceAccounts
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;&#92;n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}

GCP > KMS > Trusted Users [Default]

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

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

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

URI
tmod:@turbot/gcp-kms#/policy/types/kmsTrustedUsers
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;&#92;n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}

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

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-kms mod

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

URI
tmod:@turbot/gcp-kms#/policy/types/kmsEventPatterns
Category
Parent
Targets
Schema
{
  "type": "string",
  "default": "(((resource.type = cloudkms_keyring AND (protoPayload.authorizationInfo.permission != cloudkms.keyRings.get OR protoPayload.authorizationInfo.permission != cloudkms.keyRings.getIamPolicy OR protoPayload.authorizationInfo.permission != cloudkms.keyRings.list)) OR (resource.type = cloudkms_cryptokey AND (protoPayload.authorizationInfo.permission != cloudkms.cryptoKeys.get OR protoPayload.authorizationInfo.permission != cloudkms.cryptoKeys.getIamPolicy OR protoPayload.authorizationInfo.permission != cloudkms.cryptoKeys.list))) AND severity>=INFO AND severity<ERROR)"
}

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

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

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

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

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

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