Fix SQLServer Flex instance documentation (#411)

This commit is contained in:
João Palet 2024-06-20 15:24:40 +01:00 committed by GitHub
parent 8bcaab1401
commit 890e38f22a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 11 additions and 11 deletions

View file

@ -3,12 +3,12 @@
page_title: "stackit_sqlserverflex_instance Data Source - stackit"
subcategory: ""
description: |-
MongoDB Flex instance data source schema. Must have a region specified in the provider configuration.
SQLServer Flex instance data source schema. Must have a region specified in the provider configuration.
---
# stackit_sqlserverflex_instance (Data Source)
MongoDB Flex instance data source schema. Must have a `region` specified in the provider configuration.
SQLServer Flex instance data source schema. Must have a `region` specified in the provider configuration.
## Example Usage
@ -24,17 +24,17 @@ data "stackit_sqlserverflex_instance" "example" {
### Required
- `instance_id` (String) ID of the MongoDB Flex instance.
- `instance_id` (String) ID of the SQLServer Flex instance.
- `project_id` (String) STACKIT project ID to which the instance is associated.
### Read-Only
- `acl` (List of String) The Access Control List (ACL) for the MongoDB Flex instance.
- `acl` (List of String) The Access Control List (ACL) for the SQLServer Flex instance.
- `backup_schedule` (String) The backup schedule. Should follow the cron scheduling system format (e.g. "0 0 * * *").
- `flavor` (Attributes) (see [below for nested schema](#nestedatt--flavor))
- `id` (String) Terraform's internal data source. ID. It is structured as "`project_id`,`instance_id`".
- `name` (String) Instance name.
- `options` (Attributes) Custom parameters for the MongoDB Flex instance. (see [below for nested schema](#nestedatt--options))
- `options` (Attributes) Custom parameters for the SQLServer Flex instance. (see [below for nested schema](#nestedatt--options))
- `replicas` (Number)
- `storage` (Attributes) (see [below for nested schema](#nestedatt--storage))
- `version` (String)

View file

@ -72,20 +72,20 @@ func (r *instanceDataSource) Configure(ctx context.Context, req datasource.Confi
}
r.client = apiClient
tflog.Info(ctx, "MongoDB Flex instance client configured")
tflog.Info(ctx, "SQLServer Flex instance client configured")
}
// Schema defines the schema for the data source.
func (r *instanceDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
descriptions := map[string]string{
"main": "MongoDB Flex instance data source schema. Must have a `region` specified in the provider configuration.",
"main": "SQLServer Flex instance data source schema. Must have a `region` specified in the provider configuration.",
"id": "Terraform's internal data source. ID. It is structured as \"`project_id`,`instance_id`\".",
"instance_id": "ID of the MongoDB Flex instance.",
"instance_id": "ID of the SQLServer Flex instance.",
"project_id": "STACKIT project ID to which the instance is associated.",
"name": "Instance name.",
"acl": "The Access Control List (ACL) for the MongoDB Flex instance.",
"acl": "The Access Control List (ACL) for the SQLServer Flex instance.",
"backup_schedule": `The backup schedule. Should follow the cron scheduling system format (e.g. "0 0 * * *").`,
"options": "Custom parameters for the MongoDB Flex instance.",
"options": "Custom parameters for the SQLServer Flex instance.",
}
resp.Schema = schema.Schema{
@ -233,5 +233,5 @@ func (r *instanceDataSource) Read(ctx context.Context, req datasource.ReadReques
if resp.Diagnostics.HasError() {
return
}
tflog.Info(ctx, "MongoDB Flex instance read")
tflog.Info(ctx, "SQLServer Flex instance read")
}