Skip to content

Commit

Permalink
added docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sfc-gh-fbudzynski committed Nov 4, 2024
1 parent 4efce94 commit f86d26e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
---
page_title: "snowflake_connection Resource - terraform-provider-snowflake"
page_title: "snowflake_primary_connection Resource - terraform-provider-snowflake"
subcategory: ""
description: |-
Resource used to manage primary (not replicated) connections. For more information, check connection documentation https://docs.snowflake.com/en/sql-reference/sql/create-connection.html.
---

!> **V1 release candidate** This resource is a release candidate for the V1. It is on the list of remaining GA objects for V1. We do not expect significant changes in it before the V1. We will welcome any feedback and adjust the resource if needed. Any errors reported will be resolved with a higher priority. We encourage checking this resource out before the V1 release. Please follow the [migration guide](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md#v0970--v0980) to use it.

# snowflake_connection (Resource)
# snowflake_primary_connection (Resource)

Resource used to manage primary (not replicated) connections. For more information, check [connection documentation](https://docs.snowflake.com/en/sql-reference/sql/create-connection.html).

## Example Usage

```terraform
## Minimal
resource "snowflake_connection" "basic" {
resource "snowflake_primary_connection" "basic" {
name = "connection_name"
}
## Complete (with every optional set)
resource "snowflake_connection" "complete" {
resource "snowflake_primary_connection" "complete" {
name = "connection_name"
comment = "my complete connection"
enable_failover_to_accounts = [
Expand All @@ -47,7 +47,7 @@ resource "snowflake_connection" "complete" {

- `fully_qualified_name` (String) Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
- `id` (String) The ID of this resource.
- `show_output` (List of Object) Outputs the result of `SHOW CONNECTIONS` for the given secret. (see [below for nested schema](#nestedatt--show_output))
- `show_output` (List of Object) Outputs the result of `SHOW CONNECTIONS` for the given connection. (see [below for nested schema](#nestedatt--show_output))

<a id="nestedatt--show_output"></a>
### Nested Schema for `show_output`
Expand All @@ -72,5 +72,5 @@ Read-Only:
Import is supported using the following syntax:

```shell
terraform import snowflake_connection.example 'connection_name'
terraform import snowflake_primary_connection.example 'connection_name'
```
9 changes: 5 additions & 4 deletions docs/resources/secondary_connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,22 @@
page_title: "snowflake_secondary_connection Resource - terraform-provider-snowflake"
subcategory: ""
description: |-
Resource used to manage secondary connections. For more information, check connection documentation https://docs.snowflake.com/en/sql-reference/sql/create-connection.html.
Resource used to manage secondary connections. To promote secondary connection to primary check migraton guide https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md#connection-resources. For more information, check connection documentation https://docs.snowflake.com/en/sql-reference/sql/create-connection.html.
---

!> **V1 release candidate** This resource is a release candidate for the V1. It is on the list of remaining GA objects for V1. We do not expect significant changes in it before the V1. We will welcome any feedback and adjust the resource if needed. Any errors reported will be resolved with a higher priority. We encourage checking this resource out before the V1 release. Please follow the [migration guide](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md#v0970--v0980) to use it.

# snowflake_secondary_connection (Resource)

Resource used to manage secondary connections. For more information, check [connection documentation](https://docs.snowflake.com/en/sql-reference/sql/create-connection.html).
Resource used to manage secondary connections. To promote secondary connection to primary check [migraton guide](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md#connection-resources). For more information, check [connection documentation](https://docs.snowflake.com/en/sql-reference/sql/create-connection.html).

## Example Usage

```terraform
## Minimal
resource "snowflake_secondary_connection" "basic" {
name = "connection_name"
name = "connection_name"
as_replica_of = "<organization_name>.<account_name>.<connection_name>"
}
## Complete (with every optional set)
Expand Down Expand Up @@ -46,7 +47,7 @@ resource "snowflake_secondary_connection" "complete" {
- `fully_qualified_name` (String) Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
- `id` (String) The ID of this resource.
- `is_primary` (Boolean) Indicates if the connection has been changed to primary. If change is detected, the secondary connection will be recreated.
- `show_output` (List of Object) Outputs the result of `SHOW CONNECTIONS` for the given secret. (see [below for nested schema](#nestedatt--show_output))
- `show_output` (List of Object) Outputs the result of `SHOW CONNECTIONS` for the given connection. (see [below for nested schema](#nestedatt--show_output))

<a id="nestedatt--show_output"></a>
### Nested Schema for `show_output`
Expand Down

0 comments on commit f86d26e

Please sign in to comment.