Google Apigee Organization

This page shows how to write Terraform for Apigee Organization and write them securely.

google_apigee_organization (Terraform)

The Organization in Apigee can be configured in Terraform with the resource name google_apigee_organization. The following sections describe 2 examples of how to use the resource and its parameters.

Example Usage from GitHub
resource "google_apigee_organization" "this" {
  analytics_region                     = var.gcp_region
  display_name                         = var.apigee_display_name
  project_id                           = var.gcp_project
  authorized_network                   =
  runtime_database_encryption_key_name =
resource "google_apigee_organization" "apigee_org" {
  project_id         = google_project.project.project_id
  analytics_region   = "us-central1"
  description        = "Test Apigee Org for gcpdiag"
  authorized_network =
  depends_on = [


  • analytics_region optional - string
  • authorized_network optional - string
    • Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See Getting started with the Service Networking API. Valid only when 'RuntimeType' is set to CLOUD. The value can be updated only when there are no runtime instances. For example: "default".

  • ca_certificate requiredcomputed - string
    • Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when 'RuntimeType' is CLOUD. A base64-encoded string.

  • description optional - string
    • Description of the Apigee organization.

  • display_name optional - string
    • The display name of the Apigee organization.

  • id optionalcomputed - string
  • name requiredcomputed - string
    • Output only. Name of the Apigee organization.

  • project_id required - string
    • The project ID associated with the Apigee organization.

  • runtime_database_encryption_key_name optional - string
    • Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. If not specified, a Google-Managed encryption key will be used. Valid only when 'RuntimeType' is CLOUD. For example: 'projects/foo/locations/us/keyRings/bar/cryptoKeys/baz'.

  • runtime_type optional - string
    • Runtime type of the Apigee organization based on the Apigee subscription purchased. Default value: "CLOUD" Possible values: ["CLOUD", "HYBRID"]

  • subscription_type requiredcomputed - string
    • Output only. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased).

Explanation in Terraform Registry

An Organization is the top-level container in Apigee. To get more information about Organization, see:

Frequently asked questions

What is Google Apigee Organization?

Google Apigee Organization is a resource for Apigee of Google Cloud Platform. Settings can be wrote in Terraform.

Where can I find the example code for the Google Apigee Organization?

For Terraform, the jaredkosanovic/apigee-x and GoogleCloudPlatform/gcpdiag source code examples are useful. See the Terraform Example section for further details.


Scan your IaC problem in 3 minutes for free

You can keep your IaC security for free. No credit card required.