Google Apigee Instance

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

google_apigee_instance (Terraform)

The Instance in Apigee can be configured in Terraform with the resource name google_apigee_instance. The following sections describe 1 example of how to use the resource and its parameters.

Example Usage from GitHub
resource "google_apigee_instance" "this" {
  name                     = var.apigee_display_name
  location                 = var.gcp_region
  org_id                   =
  disk_encryption_key_name =
  peering_cidr_range       = "SLASH_16"

Review your Terraform file for Google best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).


Description of the instance.

Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: 'projects/(/+)/locations/(/+)/keyRings/(/+)/cryptoKeys/(/+)'

Display name of the instance.

  • host optional computed - string

Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.

Compute Engine location where the instance resides. For trial organization subscriptions, the location must be a Compute Engine zone. For paid organization subscriptions, it should correspond to a Compute Engine region.

Resource ID of the instance.

The Apigee Organization associated with the Apigee instance, in the format 'organizations/[[org_name]]'.

The size of the CIDR block range that will be reserved by the instance. Possible values: ["SLASH_16", "SLASH_20"]

  • port optional computed - string

Output only. Port number of the exposed Apigee endpoint.

Explanation in Terraform Registry

An Instance is the runtime dataplane in Apigee. To get more information about Instance, see:

Frequently asked questions

What is Google Apigee Instance?

Google Apigee Instance 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 Instance?

For Terraform, the jaredkosanovic/apigee-x source code example is useful. See the Terraform Example section for further details.


Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.