|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "stackit_edgecloud_instances Data Source - stackit" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + Edge Cloud is in private Beta and not generally available. |
| 7 | + You can contact support if you are interested in trying it out. |
| 8 | + ~> This datasource is in beta and may be subject to breaking changes in the future. Use with caution. See our guide https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/guides/opting_into_beta_resources for how to opt-in to use beta resources. |
| 9 | +--- |
| 10 | + |
| 11 | +# stackit_edgecloud_instances (Data Source) |
| 12 | + |
| 13 | +Edge Cloud is in private Beta and not generally available. |
| 14 | + You can contact support if you are interested in trying it out. |
| 15 | + |
| 16 | +~> This datasource is in beta and may be subject to breaking changes in the future. Use with caution. See our [guide](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/guides/opting_into_beta_resources) for how to opt-in to use beta resources. |
| 17 | + |
| 18 | +## Example Usage |
| 19 | + |
| 20 | +```terraform |
| 21 | +# returns all Edge Cloud instances created in the given project which are inside the provider default_region |
| 22 | +data "stackit_edgecloud_instances" "plan_id" { |
| 23 | + project_id = var.project_id |
| 24 | +} |
| 25 | +
|
| 26 | +# returns all Edge Cloud instances created in the given project in the given region |
| 27 | +data "stackit_edgecloud_instances" "plan_id" { |
| 28 | + project_id = var.project_id |
| 29 | + region = var.region |
| 30 | +} |
| 31 | +``` |
| 32 | + |
| 33 | +<!-- schema generated by tfplugindocs --> |
| 34 | +## Schema |
| 35 | + |
| 36 | +### Required |
| 37 | + |
| 38 | +- `project_id` (String) STACKIT project ID to which the Edge Cloud instances are associated. |
| 39 | + |
| 40 | +### Optional |
| 41 | + |
| 42 | +- `region` (String) The resource region. If not defined, the provider region is used. |
| 43 | + |
| 44 | +### Read-Only |
| 45 | + |
| 46 | +- `id` (String) Terraform's internal data source ID, structured as `project_id`,`region`. |
| 47 | +- `instances` (Attributes List) A list of Edge Cloud instances. (see [below for nested schema](#nestedatt--instances)) |
| 48 | + |
| 49 | +<a id="nestedatt--instances"></a> |
| 50 | +### Nested Schema for `instances` |
| 51 | + |
| 52 | +Read-Only: |
| 53 | + |
| 54 | +- `created` (String) The date and time the instance was created. |
| 55 | +- `description` (String) Description of the instance. |
| 56 | +- `display_name` (String) The display name of the instance. |
| 57 | +- `frontend_url` (String) Frontend URL for the Edge Cloud instance. |
| 58 | +- `instance_id` (String) The ID of the instance. |
| 59 | +- `plan_id` (String) The plan ID for the instance. |
| 60 | +- `region` (String) The region where the instance is located. |
| 61 | +- `status` (String) The status of the instance. |
0 commit comments