Skip to content

Commit 1b67222

Browse files
author
Yago Carlos Fernandez Gou
committed
Add docs
1 parent 6da1b9d commit 1b67222

File tree

2 files changed

+53
-2
lines changed

2 files changed

+53
-2
lines changed

docs/data-sources/intake_runner.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "stackit_intake_runner Data Source - stackit"
4+
subcategory: ""
5+
description: |-
6+
Datasource for STACKIT Intake Runner.
7+
---
8+
9+
# stackit_intake_runner (Data Source)
10+
11+
Datasource for STACKIT Intake Runner.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `project_id` (String) STACKIT Project ID to which the runner is associated.
21+
- `region` (String) The resource region.
22+
- `runner_id` (String) The runner ID.
23+
24+
### Read-Only
25+
26+
- `description` (String) The description of the runner.
27+
- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`region`,`runner_id`".
28+
- `labels` (Map of String) User-defined labels.
29+
- `max_message_size_kib` (Number) The maximum message size in KiB.
30+
- `max_messages_per_hour` (Number) The maximum number of messages per hour.
31+
- `name` (String) The name of the runner.

docs/resources/intake_runner.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,27 @@ description: |-
1010

1111
Manages STACKIT Intake Runner.
1212

13-
13+
## Example Usage
14+
15+
```terraform
16+
resource "stackit_intake_runner" "example" {
17+
project_id = var.project_id
18+
name = "example-runner-full"
19+
description = "An example runner for STACKIT Intake"
20+
max_message_size_kib = 2048
21+
max_messages_per_hour = 1500
22+
labels = {
23+
"created_by" = "terraform-example"
24+
"env" = "production"
25+
}
26+
region = var.region
27+
}
28+
29+
import {
30+
to = stackit_intake_runner.example
31+
id = "${var.project_id},${var.region},${var.runner_id}"
32+
}
33+
```
1434

1535
<!-- schema generated by tfplugindocs -->
1636
## Schema
@@ -30,5 +50,5 @@ Manages STACKIT Intake Runner.
3050

3151
### Read-Only
3252

33-
- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`runner_id`".
53+
- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`region`,`runner_id`".
3454
- `runner_id` (String) The runner ID.

0 commit comments

Comments
 (0)