From 07816f04940e7c19a3a5073dee6c7d3510eea6b9 Mon Sep 17 00:00:00 2001 From: Omero Saienni <39497847+omerosaienni@users.noreply.github.com> Date: Tue, 10 Sep 2024 12:19:59 +1200 Subject: [PATCH] Add new configuration document for connection ipstack (#106) --- .../config-files/connection/ipstack.md | 32 +++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/reference/config-files/connection/ipstack.md diff --git a/docs/reference/config-files/connection/ipstack.md b/docs/reference/config-files/connection/ipstack.md new file mode 100644 index 0000000..378be0c --- /dev/null +++ b/docs/reference/config-files/connection/ipstack.md @@ -0,0 +1,32 @@ +--- +title: ipstack +sidebar_label: ipstack +--- + +# ipstack + +The `ipstack` connection can be used to access IpStack resources. + +```hcl +connection "ipstack" "my_ipstack" { + access_key = "1234801fakekeyf123455e6cfaf2" +} +``` + +## Arguments + +| Name | Type | Required? | Description | +| ------------ | ------ | --------- | -------------- | +| `access_key` | String | Optional | API access key | + +All arguments are optional, and a `ipstack` connection with no arguments will behave the same as the [default connection](#default-connection). + +## Default Connection + +The `ipstack` connection type includes an implicit, default connection (`connection.ipstack.default`) that will be configured to set the `access_key` to the `IPSTACK_ACCESS_KEY` environment variable. + +```hcl +connection "ipstack" "default" { + access_key = env("IPSTACK_ACCESS_KEY") +} +```