Marcel S. Henselin
318b58339f
Some checks failed
CI Workflow / Check GoReleaser config (pull_request) Successful in 4s
CI Workflow / CI (pull_request) Failing after 13m53s
CI Workflow / Code coverage report (pull_request) Has been skipped
CI Workflow / Test readiness for publishing provider (pull_request) Successful in 16m47s
158 lines
4.5 KiB
Markdown
158 lines
4.5 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "stackitprivatepreview_sqlserverflexbeta_instance Resource - stackitprivatepreview"
|
|
subcategory: ""
|
|
description: |-
|
|
|
|
---
|
|
|
|
# stackitprivatepreview_sqlserverflexbeta_instance (Resource)
|
|
|
|
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
# without encryption and SNA
|
|
resource "stackitprivatepreview_sqlserverflexbeta_instance" "instance" {
|
|
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
name = "example-instance"
|
|
backup_schedule = "0 3 * * *"
|
|
retention_days = 31
|
|
flavor_id = "flavor_id"
|
|
storage = {
|
|
class = "premium-perf2-stackit"
|
|
size = 50
|
|
}
|
|
version = 2022
|
|
network = {
|
|
acl = ["XXX.XXX.XXX.X/XX", "XX.XXX.XX.X/XX"]
|
|
access_scope = "SNA"
|
|
}
|
|
}
|
|
|
|
# without encryption and PUBLIC
|
|
resource "stackitprivatepreview_sqlserverflexbeta_instance" "instance" {
|
|
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
name = "example-instance"
|
|
backup_schedule = "0 3 * * *"
|
|
retention_days = 31
|
|
flavor_id = "flavor_id"
|
|
storage = {
|
|
class = "premium-perf2-stackit"
|
|
size = 50
|
|
}
|
|
version = 2022
|
|
network = {
|
|
acl = ["XXX.XXX.XXX.X/XX", "XX.XXX.XX.X/XX"]
|
|
access_scope = "PUBLIC"
|
|
}
|
|
}
|
|
|
|
# with encryption and SNA
|
|
resource "stackitprivatepreview_sqlserverflexbeta_instance" "instance" {
|
|
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
name = "example-instance"
|
|
backup_schedule = "0 3 * * *"
|
|
retention_days = 31
|
|
flavor_id = "flavor_id"
|
|
storage = {
|
|
class = "premium-perf2-stackit"
|
|
size = 50
|
|
}
|
|
version = 2022
|
|
encryption = {
|
|
kek_key_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
kek_key_ring_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
kek_key_version = 1
|
|
service_account = "service_account@email"
|
|
}
|
|
network = {
|
|
acl = ["XXX.XXX.XXX.X/XX", "XX.XXX.XX.X/XX"]
|
|
access_scope = "SNA"
|
|
}
|
|
}
|
|
|
|
|
|
# Only use the import statement, if you want to import an existing sqlserverflex instance
|
|
import {
|
|
to = stackitprivatepreview_sqlserverflexalpha_instance.import-example
|
|
id = "${var.project_id},${var.region},${var.sql_instance_id}"
|
|
}
|
|
|
|
# import with identity
|
|
import {
|
|
to = stackitprivatepreview_sqlserverflexalpha_instance.import-example
|
|
identity = {
|
|
project_id = var.project_id
|
|
region = var.region
|
|
instance_id = var.sql_instance_id
|
|
}
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `backup_schedule` (String) The schedule for on what time and how often the database backup will be created. The schedule is written as a cron schedule.
|
|
- `flavor_id` (String) The id of the instance flavor.
|
|
- `name` (String) The name of the instance.
|
|
- `network` (Attributes) the network configuration of the instance. (see [below for nested schema](#nestedatt--network))
|
|
- `retention_days` (Number) The days for how long the backup files should be stored before cleaned up. 30 to 365
|
|
- `storage` (Attributes) The object containing information about the storage size and class. (see [below for nested schema](#nestedatt--storage))
|
|
- `version` (String) The sqlserver version used for the instance.
|
|
|
|
### Optional
|
|
|
|
- `encryption` (Attributes) this defines which key to use for storage encryption (see [below for nested schema](#nestedatt--encryption))
|
|
- `instance_id` (String) The ID of the instance.
|
|
- `project_id` (String) The STACKIT project ID.
|
|
- `region` (String) The region which should be addressed
|
|
|
|
### Read-Only
|
|
|
|
- `edition` (String) Edition of the MSSQL server instance
|
|
- `id` (String) The ID of the instance.
|
|
- `is_deletable` (Boolean) Whether the instance can be deleted or not.
|
|
- `replicas` (Number) How many replicas the instance should have.
|
|
- `status` (String)
|
|
|
|
<a id="nestedatt--network"></a>
|
|
### Nested Schema for `network`
|
|
|
|
Required:
|
|
|
|
- `acl` (List of String) List of IPV4 cidr.
|
|
|
|
Optional:
|
|
|
|
- `access_scope` (String) The network access scope of the instance
|
|
|
|
⚠️ **Note:** This feature is in private preview. Supplying this object is only permitted for enabled accounts. If your account does not have access, the request will be rejected.
|
|
|
|
Read-Only:
|
|
|
|
- `instance_address` (String)
|
|
- `router_address` (String)
|
|
|
|
|
|
<a id="nestedatt--storage"></a>
|
|
### Nested Schema for `storage`
|
|
|
|
Required:
|
|
|
|
- `class` (String) The storage class for the storage.
|
|
- `size` (Number) The storage size in Gigabytes.
|
|
|
|
|
|
<a id="nestedatt--encryption"></a>
|
|
### Nested Schema for `encryption`
|
|
|
|
Required:
|
|
|
|
- `kek_key_id` (String) The key identifier
|
|
- `kek_key_ring_id` (String) The keyring identifier
|
|
- `kek_key_version` (String) The key version
|
|
- `service_account` (String)
|