fix: add missing docs
This commit is contained in:
parent
29f693308e
commit
b374a2b300
3 changed files with 158 additions and 0 deletions
40
docs/data-sources/postgresflexalpha_database.md
Normal file
40
docs/data-sources/postgresflexalpha_database.md
Normal file
|
|
@ -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 generated by tfplugindocs -->
|
||||||
|
## 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.
|
||||||
86
docs/data-sources/postgresflexalpha_instance.md
Normal file
86
docs/data-sources/postgresflexalpha_instance.md
Normal file
|
|
@ -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 generated by tfplugindocs -->
|
||||||
|
## 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)
|
||||||
|
|
||||||
|
<a id="nestedatt--encryption"></a>
|
||||||
|
### Nested Schema for `encryption`
|
||||||
|
|
||||||
|
Read-Only:
|
||||||
|
|
||||||
|
- `key_id` (String)
|
||||||
|
- `key_version` (String)
|
||||||
|
- `keyring_id` (String)
|
||||||
|
- `service_account` (String)
|
||||||
|
|
||||||
|
|
||||||
|
<a id="nestedatt--flavor"></a>
|
||||||
|
### Nested Schema for `flavor`
|
||||||
|
|
||||||
|
Read-Only:
|
||||||
|
|
||||||
|
- `cpu` (Number)
|
||||||
|
- `description` (String)
|
||||||
|
- `id` (String)
|
||||||
|
- `node_type` (String)
|
||||||
|
- `ram` (Number)
|
||||||
|
|
||||||
|
|
||||||
|
<a id="nestedatt--network"></a>
|
||||||
|
### 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)
|
||||||
|
|
||||||
|
|
||||||
|
<a id="nestedatt--storage"></a>
|
||||||
|
### Nested Schema for `storage`
|
||||||
|
|
||||||
|
Read-Only:
|
||||||
|
|
||||||
|
- `class` (String)
|
||||||
|
- `size` (Number)
|
||||||
32
docs/resources/postgresflex_database.md
Normal file
32
docs/resources/postgresflex_database.md
Normal file
|
|
@ -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 generated by tfplugindocs -->
|
||||||
|
## 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`".
|
||||||
Loading…
Add table
Add a link
Reference in a new issue