* docs: add system routes description --------- Signed-off-by: Mauritz Uphoff <mauritz.uphoff@stackit.cloud>
48 lines
2.2 KiB
Markdown
48 lines
2.2 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "stackit_routing_table Data Source - stackit"
|
|
subcategory: ""
|
|
description: |-
|
|
Routing table datasource schema. Must have a region specified in the provider configuration.
|
|
~> This datasource is part of the routing-tables experiment and is likely going to undergo significant changes or be removed in the future. Use it at your own discretion.
|
|
---
|
|
|
|
# stackit_routing_table (Data Source)
|
|
|
|
Routing table datasource schema. Must have a `region` specified in the provider configuration.
|
|
|
|
~> This datasource is part of the routing-tables experiment and is likely going to undergo significant changes or be removed in the future. Use it at your own discretion.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
data "stackit_routing_table" "example" {
|
|
organization_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
network_area_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
routing_table_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `network_area_id` (String) The network area ID to which the routing table is associated.
|
|
- `organization_id` (String) STACKIT organization ID to which the routing table is associated.
|
|
- `routing_table_id` (String) The routing tables ID.
|
|
|
|
### Optional
|
|
|
|
- `region` (String) The resource region. If not defined, the provider region is used.
|
|
|
|
### Read-Only
|
|
|
|
- `created_at` (String) Date-time when the routing table was created
|
|
- `default` (Boolean) When true this is the default routing table for this network area. It can't be deleted and is used if the user does not specify it otherwise.
|
|
- `description` (String) Description of the routing table.
|
|
- `id` (String) Terraform's internal datasource ID. It is structured as "`organization_id`,`region`,`network_area_id`,`routing_table_id`".
|
|
- `labels` (Map of String) Labels are key-value string pairs which can be attached to a resource container
|
|
- `name` (String) The name of the routing table.
|
|
- `system_routes` (Boolean) This controls whether the routes for project-to-project communication are created automatically or not.
|
|
- `updated_at` (String) Date-time when the routing table was updated
|