114 lines
3.3 KiB
Markdown
114 lines
3.3 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "stackitprivatepreview_postgresflexalpha_instance Resource - stackitprivatepreview"
|
|
subcategory: ""
|
|
description: |-
|
|
Postgres Flex instance resource schema. Must have a region specified in the provider configuration.
|
|
---
|
|
|
|
# stackitprivatepreview_postgresflexalpha_instance (Resource)
|
|
|
|
Postgres Flex instance resource schema. Must have a `region` specified in the provider configuration.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
resource "stackitprivatepreview_postgresflexalpha_instance" "example" {
|
|
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
name = "example-instance"
|
|
acl = ["XXX.XXX.XXX.X/XX", "XX.XXX.XX.X/XX"]
|
|
backup_schedule = "00 00 * * *"
|
|
flavor = {
|
|
cpu = 2
|
|
ram = 4
|
|
}
|
|
replicas = 3
|
|
storage = {
|
|
class = "class"
|
|
size = 5
|
|
}
|
|
version = 14
|
|
}
|
|
|
|
# Only use the import statement, if you want to import an existing postgresflex instance
|
|
import {
|
|
to = stackitprivatepreview_postgresflexalpha_instance.import-example
|
|
id = "${var.project_id},${var.region},${var.postgres_instance_id}"
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `backup_schedule` (String)
|
|
- `encryption` (Attributes) The encryption block. (see [below for nested schema](#nestedatt--encryption))
|
|
- `flavor` (Attributes) The block that defines the flavor data. (see [below for nested schema](#nestedatt--flavor))
|
|
- `name` (String) Instance name.
|
|
- `network` (Attributes) The network block configuration. (see [below for nested schema](#nestedatt--network))
|
|
- `project_id` (String) STACKIT project ID to which the instance is associated.
|
|
- `replicas` (Number)
|
|
- `retention_days` (Number) The days of the retention period.
|
|
- `storage` (Attributes) (see [below for nested schema](#nestedatt--storage))
|
|
- `version` (String) The database version used.
|
|
|
|
### 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`".
|
|
- `instance_id` (String) ID of the PostgresFlex instance.
|
|
|
|
<a id="nestedatt--encryption"></a>
|
|
### Nested Schema for `encryption`
|
|
|
|
Required:
|
|
|
|
- `key_id` (String) Key ID of the encryption key.
|
|
- `key_version` (String) Key version of the encryption key.
|
|
- `keyring_id` (String) KeyRing ID of the encryption key.
|
|
- `service_account` (String) The service account ID of the service account.
|
|
|
|
|
|
<a id="nestedatt--flavor"></a>
|
|
### Nested Schema for `flavor`
|
|
|
|
Required:
|
|
|
|
- `cpu` (Number) The CPU count of the flavor.
|
|
- `ram` (Number) The RAM count of the flavor.
|
|
|
|
Optional:
|
|
|
|
- `id` (String) The ID of the flavor.
|
|
- `node_type` (String) The node type of the flavor. (Single or Replicas)
|
|
|
|
Read-Only:
|
|
|
|
- `description` (String) The flavor detailed flavor name.
|
|
|
|
|
|
<a id="nestedatt--network"></a>
|
|
### Nested Schema for `network`
|
|
|
|
Required:
|
|
|
|
- `acl` (List of String) The Access Control List (ACL) for the PostgresFlex instance.
|
|
|
|
Optional:
|
|
|
|
- `access_scope` (String) The access scope. (Either SNA or PUBLIC)
|
|
- `instance_address` (String) The returned instance address.
|
|
- `router_address` (String) The returned router address.
|
|
|
|
|
|
<a id="nestedatt--storage"></a>
|
|
### Nested Schema for `storage`
|
|
|
|
Required:
|
|
|
|
- `class` (String) The storage class used.
|
|
- `size` (Number) The disk size of the storage.
|