* chore(examples): Add import examples for all resources Signed-off-by: Alexander Dahmen <alexander.dahmen@inovex.de> * Add guide: How to import resources Signed-off-by: Alexander Dahmen <alexander.dahmen@inovex.de> --------- Signed-off-by: Alexander Dahmen <alexander.dahmen@inovex.de>
50 lines
1.7 KiB
Markdown
50 lines
1.7 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "stackit_network_area_route Resource - stackit"
|
|
subcategory: ""
|
|
description: |-
|
|
Network area route resource schema. Must have a region specified in the provider configuration.
|
|
---
|
|
|
|
# stackit_network_area_route (Resource)
|
|
|
|
Network area route resource schema. Must have a `region` specified in the provider configuration.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
resource "stackit_network_area_route" "example" {
|
|
organization_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
network_area_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
prefix = "192.168.0.0/24"
|
|
next_hop = "192.168.0.0"
|
|
labels = {
|
|
"key" = "value"
|
|
}
|
|
}
|
|
|
|
# Only use the import statement, if you want to import an existing network area route
|
|
import {
|
|
to = stackit_network_area_route.import-example
|
|
id = "${var.organization_id},${var.network_area_id},${var.network_area_route_id}"
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `network_area_id` (String) The network area ID to which the network area route is associated.
|
|
- `next_hop` (String) The IP address of the routing system, that will route the prefix configured. Should be a valid IPv4 address.
|
|
- `organization_id` (String) STACKIT organization ID to which the network area is associated.
|
|
- `prefix` (String) The network, that is reachable though the Next Hop. Should use CIDR notation.
|
|
|
|
### Optional
|
|
|
|
- `labels` (Map of String) Labels are key-value string pairs which can be attached to a resource container
|
|
|
|
### Read-Only
|
|
|
|
- `id` (String) Terraform's internal resource ID. It is structured as "`organization_id`,`network_area_id`,`network_area_route_id`".
|
|
- `network_area_route_id` (String) The network area route ID.
|