2021-08-05 02:57:22 -07:00
# Google Apigee X Instance Module
2021-08-04 08:09:44 -07:00
This module allows managing a single Apigee X instance and its environment attachments.
## Examples
### Apigee X Evaluation Instance
```hcl
module "apigee-x-instance" {
source = "./modules/apigee-x-instance"
name = "my-us-instance"
region = "us-central1"
2022-02-02 10:32:26 -08:00
ip_range = "10.0.0.0/22"
2021-08-04 08:09:44 -07:00
apigee_org_id = "my-project"
apigee_environments = [
"eval1",
"eval2"
]
}
2022-01-28 11:15:35 -08:00
# tftest modules=1 resources=3
2021-08-04 08:09:44 -07:00
```
2021-08-05 04:21:57 -07:00
### Apigee X Paid Instance
```hcl
module "apigee-x-instance" {
source = "./modules/apigee-x-instance"
name = "my-us-instance"
region = "us-central1"
2022-02-02 10:32:26 -08:00
ip_range = "10.0.0.0/22"
2021-08-05 04:21:57 -07:00
disk_encryption_key = "my-disk-key"
apigee_org_id = "my-project"
apigee_environments = [
"dev1",
"dev2",
"test1",
"test2"
]
}
2022-01-28 11:15:35 -08:00
# tftest modules=1 resources=5
2021-08-05 04:21:57 -07:00
```
2021-08-04 08:09:44 -07:00
<!-- BEGIN TFDOC -->
2021-12-20 23:51:51 -08:00
2021-08-05 05:25:50 -07:00
## Variables
| name | description | type | required | default |
2021-12-20 23:51:51 -08:00
|---|---|:---:|:---:|:---:|
2022-01-31 01:45:34 -08:00
| [apigee_org_id ](variables.tf#L32 ) | Apigee Organization ID. | < code > string</ code > | ✓ | |
2022-02-02 10:32:26 -08:00
| [ip_range ](variables.tf#L37 ) | Customer-provided CIDR block of length 22 for the Apigee instance. | < code > string</ code > | ✓ | |
2022-01-22 04:34:35 -08:00
| [name ](variables.tf#L52 ) | Apigee instance name. | < code > string</ code > | ✓ | |
| [region ](variables.tf#L57 ) | Compute region. | < code > string</ code > | ✓ | |
| [apigee_envgroups ](variables.tf#L17 ) | Apigee Environment Groups. | < code title = "map(object({ environments = list(string) hostnames = list(string) }))" > map( object({…})) </ code > | | < code > {} </ code > |
| [apigee_environments ](variables.tf#L26 ) | Apigee Environment Names. | < code > list( string) </ code > | | < code > [] </ code > |
| [disk_encryption_key ](variables.tf#L46 ) | 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). | < code > string</ code > | | < code > null</ code > |
2021-08-05 05:25:50 -07:00
## Outputs
| name | description | sensitive |
|---|---|:---:|
2022-01-22 04:34:35 -08:00
| [endpoint ](outputs.tf#L17 ) | Internal endpoint of the Apigee instance. | |
| [id ](outputs.tf#L22 ) | Apigee instance ID. | |
| [instance ](outputs.tf#L27 ) | Apigee instance. | |
| [port ](outputs.tf#L32 ) | Port number of the internal endpoint of the Apigee instance. | |
2021-12-20 23:51:51 -08:00
2021-08-04 08:09:44 -07:00
<!-- END TFDOC -->