cloud-foundation-fabric/modules/apigee-x-instance/README.md

2.5 KiB

Google Apigee X Instance Module

This module allows managing a single Apigee X instance and its environment attachments.

Examples

Apigee X Evaluation Instance

module "apigee-x-instance" {
  source             = "./modules/apigee-x-instance"
  name               = "my-us-instance"
  region             = "us-central1"
  ip_range           = "10.0.0.0/22"

  apigee_org_id      = "my-project"
  apigee_environments = [
    "eval1",
    "eval2"
  ]
}
# tftest modules=1 resources=3

Apigee X Paid Instance

module "apigee-x-instance" {
  source              = "./modules/apigee-x-instance"
  name                = "my-us-instance"
  region              = "us-central1"
  ip_range            = "10.0.0.0/22"
  disk_encryption_key = "my-disk-key"

  apigee_org_id       = "my-project"
  apigee_environments = [
    "dev1",
    "dev2",
    "test1",
    "test2"
  ]
}
# tftest modules=1 resources=5

Variables

name description type required default
apigee_org_id Apigee Organization ID. string
ip_range Customer-provided CIDR block of length 22 for the Apigee instance. string
name Apigee instance name. string
region Compute region. string
apigee_envgroups Apigee Environment Groups. map(object({…})) {}
apigee_environments Apigee Environment Names. list(string) []
disk_encryption_key Customer Managed Encryption Key (CMEK) self link (e.g. projects/foo/locations/us/keyRings/bar/cryptoKeys/baz) used for disk and volume encryption (required for PAID Apigee Orgs only). string null

Outputs

name description sensitive
endpoint Internal endpoint of the Apigee instance.
id Apigee instance ID.
instance Apigee instance.
port Port number of the internal endpoint of the Apigee instance.