Skip to content

Commit d10b735

Browse files
authored
add examples in docs/resources/connection.md (#46)
1 parent e40227a commit d10b735

File tree

2 files changed

+109
-0
lines changed

2 files changed

+109
-0
lines changed

docs/resources/connection.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,103 @@ resource "trocco_connection" "snowflake" {
4848
}
4949
```
5050

51+
### Google Cloud Storage(GCS)
52+
53+
```terraform
54+
resource "trocco_connection" "gcs" {
55+
connection_type = "gcs"
56+
57+
name = "GCS Example"
58+
description = "This is a Google Cloud Storage(GCS) connection example"
59+
60+
project_id = "example-project-id"
61+
service_account_json_key = <<JSON
62+
{
63+
"type": "service_account",
64+
"project_id": "example-project-id",
65+
"private_key_id": "example-private-key-id",
66+
"private_key":"-----BEGIN PRIVATE KEY-----\n..."
67+
}
68+
JSON
69+
service_account_email = "[email protected]"
70+
application_name = "example-application-name"
71+
}
72+
```
73+
74+
### MySQL
75+
76+
```terraform
77+
resource "trocco_connection" "mysql" {
78+
connection_type = "mysql"
79+
name = "MySQL Example"
80+
description = "This is a MySQL connection example"
81+
host = "db.example.com"
82+
port = 65535
83+
user_name = "root"
84+
password = "password"
85+
ssl = {
86+
ca = <<-SSL_CA
87+
-----BEGIN PRIVATE KEY-----
88+
...SSL CA...
89+
-----END PRIVATE KEY-----
90+
SSL_CA
91+
cert = <<-SSL_CERT
92+
-----BEGIN CERTIFICATE-----
93+
...SSL CRT...
94+
-----END CERTIFICATE-----
95+
SSL_CERT
96+
key = <<-SSL_KEY
97+
-----BEGIN PRIVATE KEY-----
98+
...SSL KEY...
99+
-----END PRIVATE KEY-----
100+
SSL_KEY
101+
}
102+
gateway = {
103+
host = "gateway.example.com"
104+
port = 1234
105+
user_name = "gateway-joe"
106+
password = "gateway-joepass"
107+
key = <<-GATEWAY_KEY
108+
-----BEGIN PRIVATE KEY-----
109+
... GATEWAY KEY...
110+
-----END PRIVATE KEY-----
111+
GATEWAY_KEY
112+
key_passphrase = "sample_passphrase"
113+
}
114+
resource_group_id = 1
115+
}
116+
```
117+
118+
### S3
119+
120+
```terraform
121+
resource "trocco_connection" "s3" {
122+
connection_type = "s3"
123+
124+
name = "S3 Example"
125+
description = "This is a AWS S3 connection example"
126+
127+
aws_auth_type = "iam_user"
128+
aws_iam_user = {
129+
access_key_id = "YOUR_ACCESS_KEY_ID"
130+
secret_access_key = "YOUR_SECRET_ACCESS_KEY"
131+
}
132+
}
133+
134+
resource "trocco_connection" "s3_with_assume_role" {
135+
connection_type = "s3"
136+
137+
name = "S3 Example"
138+
description = "This is a AWS S3 connection example"
139+
140+
aws_auth_type = "assume_role"
141+
aws_assume_role = {
142+
account_id = "123456789012"
143+
role_name = "YOUR_ROLE_NAME"
144+
}
145+
}
146+
```
147+
51148
<!-- schema generated by tfplugindocs -->
52149
## Schema
53150

templates/resources/connection.md.tmpl

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,18 @@ description: |-
1919

2020
{{codefile "terraform" "examples/resources/trocco_connection/snowflake.tf"}}
2121

22+
### Google Cloud Storage(GCS)
23+
24+
{{codefile "terraform" "examples/resources/trocco_connection/gcs.tf"}}
25+
26+
### MySQL
27+
28+
{{codefile "terraform" "examples/resources/trocco_connection/mysql.tf"}}
29+
30+
### S3
31+
32+
{{codefile "terraform" "examples/resources/trocco_connection/s3.tf"}}
33+
2234
{{.SchemaMarkdown}}
2335

2436
## Import

0 commit comments

Comments
 (0)