Skip to content

googleProjectAccessApprovalSettings

Access Approval enables you to require your explicit approval whenever Google support and engineering need to access your customer content.

To get more information about ProjectSettings, see:

Example Usage - Project Access Approval Full

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.projectAccessApprovalSettings.ProjectAccessApprovalSettings(
  this,
  "project_access_approval",
  {
    enrolled_services: [
      {
        cloud_product: "all",
        enrollment_level: "BLOCK_ALL",
      },
    ],
    notification_emails: ["testuser@example.com", "example.user@example.com"],
    project_id: "my-project-name",
  }
);

Example Usage - Project Access Approval Active Key Version

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const googleKmsKeyRingKeyRing = new google.kmsKeyRing.KmsKeyRing(
  this,
  "key_ring",
  {
    location: "global",
    name: "key-ring",
    project: "my-project-name",
  }
);
const dataGoogleAccessApprovalProjectServiceAccountServiceAccount =
  new google.dataGoogleAccessApprovalProjectServiceAccount.DataGoogleAccessApprovalProjectServiceAccount(
    this,
    "service_account",
    {
      project_id: "my-project-name",
    }
  );
const googleKmsCryptoKeyCryptoKey = new google.kmsCryptoKey.KmsCryptoKey(
  this,
  "crypto_key",
  {
    key_ring: googleKmsKeyRingKeyRing.id,
    name: "crypto-key",
    purpose: "ASYMMETRIC_SIGN",
    version_template: [
      {
        algorithm: "EC_SIGN_P384_SHA384",
      },
    ],
  }
);
const googleKmsCryptoKeyIamMemberIam =
  new google.kmsCryptoKeyIamMember.KmsCryptoKeyIamMember(this, "iam", {
    crypto_key_id: googleKmsCryptoKeyCryptoKey.id,
    member: `serviceAccount:\${${dataGoogleAccessApprovalProjectServiceAccountServiceAccount.accountEmail}}`,
    role: "roles/cloudkms.signerVerifier",
  });
const dataGoogleKmsCryptoKeyVersionCryptoKeyVersion =
  new google.dataGoogleKmsCryptoKeyVersion.DataGoogleKmsCryptoKeyVersion(
    this,
    "crypto_key_version",
    {
      crypto_key: googleKmsCryptoKeyCryptoKey.id,
    }
  );
new google.projectAccessApprovalSettings.ProjectAccessApprovalSettings(
  this,
  "project_access_approval",
  {
    active_key_version: dataGoogleKmsCryptoKeyVersionCryptoKeyVersion.name,
    depends_on: [`\${${googleKmsCryptoKeyIamMemberIam.fqn}}`],
    enrolled_services: [
      {
        cloud_product: "all",
      },
    ],
    project_id: "my-project-name",
  }
);

Argument Reference

The following arguments are supported:

  • enrolledServices - (Required) A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. Enrollment can only be done on an all or nothing basis. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. Structure is documented below.

  • projectId - (Required) ID of the project of the access approval settings.

The enrolledServices block supports:

  • cloudProduct - (Required) The product for which Access Approval will be enrolled. Allowed values are listed (case-sensitive): all appengine.googleapis.com bigquery.googleapis.com bigtable.googleapis.com cloudkms.googleapis.com compute.googleapis.com dataflow.googleapis.com iam.googleapis.com pubsub.googleapis.com storage.googleapis.com

  • enrollmentLevel - (Optional) The enrollment level of the service. Default value is blockAll. Possible values are blockAll.

  • notificationEmails - (Optional) A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.

  • activeKeyVersion - (Optional) The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of the resource, and new non-empty values may not be set.

  • project - (Optional, Deprecated) Deprecated in favor of projectId

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

  • id - an identifier for the resource with format projects/{{projectId}}/accessApprovalSettings

  • name - The resource name of the settings. Format is "projects/{project_id}/accessApprovalSettings"

  • enrolledAncestor - If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project.

  • ancestorHasActiveKeyVersion - If the field is true, that indicates that an ancestor of this Project has set active_key_version.

  • invalidKeyVersion - If the field is true, that indicates that there is some configuration issue with the active_key_version configured on this Project (e.g. it doesn't exist or the Access Approval service account doesn't have the correct permissions on it, etc.) This key version is not necessarily the effective key version at this level, as key versions are inherited top-down.

Timeouts

This resource provides the following Timeouts configuration options:

  • create - Default is 20 minutes.
  • update - Default is 20 minutes.
  • delete - Default is 20 minutes.

Import

ProjectSettings can be imported using any of these accepted formats:

$ terraform import google_project_access_approval_settings.default projects/{{project_id}}/accessApprovalSettings
$ terraform import google_project_access_approval_settings.default {{project_id}}