From b374a2b3003202ae04187f2d83efe901fbf7557f Mon Sep 17 00:00:00 2001 From: "Marcel S. Henselin" Date: Tue, 30 Dec 2025 16:31:42 +0100 Subject: [PATCH] fix: add missing docs --- .../postgresflexalpha_database.md | 40 +++++++++ .../postgresflexalpha_instance.md | 86 +++++++++++++++++++ docs/resources/postgresflex_database.md | 32 +++++++ 3 files changed, 158 insertions(+) create mode 100644 docs/data-sources/postgresflexalpha_database.md create mode 100644 docs/data-sources/postgresflexalpha_instance.md create mode 100644 docs/resources/postgresflex_database.md diff --git a/docs/data-sources/postgresflexalpha_database.md b/docs/data-sources/postgresflexalpha_database.md new file mode 100644 index 00000000..f7d0bf2a --- /dev/null +++ b/docs/data-sources/postgresflexalpha_database.md @@ -0,0 +1,40 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "stackitprivatepreview_postgresflexalpha_database Data Source - stackitprivatepreview" +subcategory: "" +description: |- + Postgres Flex database resource schema. Must have a region specified in the provider configuration. +--- + +# stackitprivatepreview_postgresflexalpha_database (Data Source) + +Postgres Flex database resource schema. Must have a `region` specified in the provider configuration. + +## Example Usage + +```terraform +data "stackitprivatepreview_postgresflexalpha_database" "example" { + project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + instance_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +} +``` + + +## Schema + +### Required + +- `database_id` (String) Database ID. +- `instance_id` (String) ID of the Postgres Flex instance. +- `project_id` (String) STACKIT project ID to which the instance is associated. + +### Optional + +- `region` (String) The resource region. If not defined, the provider region is used. + +### Read-Only + +- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`region`,`instance_id`,`database_id`". +- `name` (String) Database name. +- `owner` (String) Username of the database owner. diff --git a/docs/data-sources/postgresflexalpha_instance.md b/docs/data-sources/postgresflexalpha_instance.md new file mode 100644 index 00000000..cb387c9d --- /dev/null +++ b/docs/data-sources/postgresflexalpha_instance.md @@ -0,0 +1,86 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "stackitprivatepreview_postgresflexalpha_instance Data Source - stackitprivatepreview" +subcategory: "" +description: |- + Postgres Flex instance data source schema. Must have a region specified in the provider configuration. +--- + +# stackitprivatepreview_postgresflexalpha_instance (Data Source) + +Postgres Flex instance data source schema. Must have a `region` specified in the provider configuration. + +## Example Usage + +```terraform +data "stackitprivatepreview_postgresflexalpha_instance" "example" { + project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + instance_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +} +``` + + +## Schema + +### Required + +- `instance_id` (String) ID of the PostgresFlex instance. +- `project_id` (String) STACKIT project ID to which the instance is associated. + +### Optional + +- `region` (String) The resource region. If not defined, the provider region is used. + +### Read-Only + +- `backup_schedule` (String) +- `encryption` (Attributes) (see [below for nested schema](#nestedatt--encryption)) +- `flavor` (Attributes) (see [below for nested schema](#nestedatt--flavor)) +- `id` (String) Terraform's internal data source. ID. It is structured as "`project_id`,`region`,`instance_id`". +- `name` (String) Instance name. +- `network` (Attributes) (see [below for nested schema](#nestedatt--network)) +- `replicas` (Number) +- `storage` (Attributes) (see [below for nested schema](#nestedatt--storage)) +- `version` (String) + + +### Nested Schema for `encryption` + +Read-Only: + +- `key_id` (String) +- `key_version` (String) +- `keyring_id` (String) +- `service_account` (String) + + + +### Nested Schema for `flavor` + +Read-Only: + +- `cpu` (Number) +- `description` (String) +- `id` (String) +- `node_type` (String) +- `ram` (Number) + + + +### Nested Schema for `network` + +Read-Only: + +- `access_scope` (String) +- `acl` (List of String) The Access Control List (ACL) for the PostgresFlex instance. +- `instance_address` (String) +- `router_address` (String) + + + +### Nested Schema for `storage` + +Read-Only: + +- `class` (String) +- `size` (Number) diff --git a/docs/resources/postgresflex_database.md b/docs/resources/postgresflex_database.md new file mode 100644 index 00000000..d36f1712 --- /dev/null +++ b/docs/resources/postgresflex_database.md @@ -0,0 +1,32 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "stackitprivatepreview_postgresflex_database Resource - stackitprivatepreview" +subcategory: "" +description: |- + Postgres Flex database resource schema. Must have a region specified in the provider configuration. +--- + +# stackitprivatepreview_postgresflex_database (Resource) + +Postgres Flex database resource schema. Must have a `region` specified in the provider configuration. + + + + +## Schema + +### Required + +- `instance_id` (String) ID of the Postgres Flex instance. +- `name` (String) Database name. +- `owner` (String) Username of the database owner. +- `project_id` (String) STACKIT project ID to which the instance is associated. + +### Optional + +- `region` (String) The resource region. If not defined, the provider region is used. + +### Read-Only + +- `database_id` (String) Database ID. +- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`region`,`instance_id`,`database_id`".