Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions docs/data-sources/intakes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "stackit_intakes Data Source - stackit"
subcategory: ""
description: |-
Datasource for STACKIT Intake.
---

# stackit_intakes (Data Source)

Datasource for STACKIT Intake.

## Example Usage

```terraform
data "stackit_intakes" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
intake_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `intake_id` (String) The intake ID.
- `project_id` (String) STACKIT Project ID to which the intake is associated.

### Optional

- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `catalog_auth_type` (String) The catalog authentication type.
- `catalog_namespace` (String) The catalog namespace.
- `catalog_partition_by` (List of String) The catalog partition by.
- `catalog_partitioning` (String) The catalog partitioning.
- `catalog_table_name` (String) The catalog table name.
- `catalog_uri` (String) The catalog URI.
- `catalog_warehouse` (String) The catalog warehouse.
- `create_time` (String) The creation time of the intake.
- `dead_letter_topic` (String) The topic where undelivered messages are published (Dead Letter Queue).
- `description` (String) The description of the intake.
- `display_name` (String) The display name of the intake.
- `dremio_token_endpoint` (String) The Dremio token endpoint.
- `id` (String) Terraform's internal resource identifier. It is structured as `project_id`,`region`,`intake_id`.
- `labels` (Map of String) User-defined labels.
- `runner_id` (String) The runner ID.
- `topic` (String) The topic to publish data to.
- `uri` (String) The URI of the intake.
83 changes: 83 additions & 0 deletions docs/resources/intakes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "stackit_intakes Resource - stackit"
subcategory: ""
description: |-
Manages STACKIT Intake.
---

# stackit_intakes (Resource)

Manages STACKIT Intake.

## Example Usage

```terraform
resource "stackit_intakes" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
runner_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
display_name = "example-intake"
description = "An example intake for STACKIT Intake service"
catalog_auth_type = "dremio"
catalog_warehouse = "default"
catalog_uri = "https://dremio.eu01.onstackit.cloud/iceberg"
dremio_token_endpoint = "https://dremio.eu01.onstackit.cloud/oauth/token"
dremio_personal_access_token_wo = "my-dremio-pat-token"
dremio_personal_access_token_wo_version = 1

labels = {
"env" = "development"
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `catalog_uri` (String) The catalog URI.
- `catalog_warehouse` (String) The catalog warehouse.
- `display_name` (String) The display name of the intake.
- `project_id` (String) STACKIT Project ID to which the intake is associated.
- `runner_id` (String) The runner ID.

### Optional

> **NOTE**: [Write-only arguments](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments) are supported in Terraform 1.11 and later.

- `catalog_auth_type` (String) The catalog authentication type.
- `catalog_namespace` (String) The catalog namespace.
- `catalog_partition_by` (List of String) The catalog partition by.
- `catalog_partitioning` (String) The catalog partitioning.
- `catalog_table_name` (String) The catalog table name.
- `description` (String) The description of the intake.
- `dremio_personal_access_token` (String, Sensitive) The Dremio personal access token. Write-only argument `dremio_personal_access_token_wo` should be preferred.
- `dremio_personal_access_token_wo` (String, Sensitive, [Write-only](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments)) The Dremio personal access token. Write-only - never stored in state and never returned by the API. To rotate the token, update this value AND increment `dremio_personal_access_token_wo_version`. Changing this field alone will NOT trigger an update.
- `dremio_personal_access_token_wo_version` (Number) User-managed rotation counter for `dremio_personal_access_token_wo`. Must be incremented every time `dremio_personal_access_token_wo` is changed. Terraform diffs this field to detect token rotations - changing `dremio_personal_access_token_wo` alone will NOT trigger an update because it is write-only and never stored in state.
- `dremio_token_endpoint` (String) The Dremio token endpoint.
- `labels` (Map of String) User-defined labels.
- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `create_time` (String) The creation time of the intake.
- `dead_letter_topic` (String) The topic where undelivered messages are published (Dead Letter Queue).
- `id` (String) Terraform's internal resource identifier. It is structured as `project_id`,`region`,`intake_id`.
- `intake_id` (String) The intake ID.
- `topic` (String) The topic to publish data to.
- `uri` (String) The URI of the intake.

## Import

Import is supported using the following syntax:

In Terraform v1.5.0 and later, the [` + "`" + `import` + "`" + ` block](https://developer.hashicorp.com/terraform/language/import) can be used with the ` + "`" + `id` + "`" + ` attribute, for example:

```terraform
# Only use the import statement, if you want to import an existing intake
import {
to = stackit_intakes.import-example
id = "${var.project_id},${var.region},${var.intake_id}"
}
```
4 changes: 4 additions & 0 deletions examples/data-sources/stackit_intakes/data-source.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
data "stackit_intakes" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
intake_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
5 changes: 5 additions & 0 deletions examples/resources/stackit_intakes/import-by-string-id.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Only use the import statement, if you want to import an existing intake
import {
to = stackit_intakes.import-example
id = "${var.project_id},${var.region},${var.intake_id}"
}
16 changes: 16 additions & 0 deletions examples/resources/stackit_intakes/resource.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
resource "stackit_intakes" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
runner_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
display_name = "example-intake"
description = "An example intake for STACKIT Intake service"
catalog_auth_type = "dremio"
catalog_warehouse = "default"
catalog_uri = "https://dremio.eu01.onstackit.cloud/iceberg"
dremio_token_endpoint = "https://dremio.eu01.onstackit.cloud/oauth/token"
dremio_personal_access_token_wo = "my-dremio-pat-token"
dremio_personal_access_token_wo_version = 1

labels = {
"env" = "development"
}
}
Comment thread
Fyusel marked this conversation as resolved.
Loading