Merge pull request #176 from stackql/feature/doc-updates

updated aws docs
stackql · Jul 5, 2024 · f655add · f655add
2 parents 6722fd5 + 92a0458
commit f655add
Showing 1 changed file with 76 additions and 75 deletions.
diff --git a/docs/aws-docs/index.md b/docs/aws-docs/index.md
@@ -1,25 +1,25 @@
----
-title: aws
-hide_title: false
-hide_table_of_contents: false
-keywords:
-  - aws
-  - aws cloud control
-  - cloud control api
-  - stackql
-  - infrastructure-as-code
-  - configuration-as-data
-  - cloud inventory
-description: Query, deploy and manage AWS resources using SQL
-custom_edit_url: null
-image: /img/providers/aws/stackql-aws-provider-featured-image.png
-id: aws-doc
-slug: /providers/aws
-
----
-
-import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
-
+---
+title: aws
+hide_title: false
+hide_table_of_contents: false
+keywords:
+  - aws
+  - aws cloud control
+  - cloud control api
+  - stackql
+  - infrastructure-as-code
+  - configuration-as-data
+  - cloud inventory
+description: Query, deploy and manage AWS resources using SQL
+custom_edit_url: null
+image: /img/providers/aws/stackql-aws-provider-featured-image.png
+id: aws-doc
+slug: /providers/aws
+
+---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
 Cloud services from AWS.
 
 :::info Provider Summary (v24.07.00244)
@@ -33,59 +33,59 @@ Cloud services from AWS.
 
 :::
 
-See also:   
-[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe)  [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
-* * * 
-
-## Installation
-
-To pull the latest version of the `aws` provider, run the following command:  
-
-```bash
-REGISTRY PULL aws;
-```
-> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).  
-
-## Authentication
-
-The following system environment variables are used for authentication by default:  
-
-- <CopyableCode code="AWS_ACCESS_KEY_ID" /> - AWS Access Key ID (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html">How to Create AWS Credentials</a>)
-- <CopyableCode code="AWS_SECRET_ACCESS_KEY" /> - AWS Secret Access Key (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html">How to Create AWS Credentials</a>)
-- <CopyableCode code="AWS_SESSION_TOKEN" /> - [<i>OPTIONAL:</i> only required if using <CopyableCode code="aws sts assume-role" />] AWS Session Token (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary security credentials in IAM</a>)
-
-These variables are sourced at runtime (from the local machine or as CI variables/secrets).  
-
-<details>
-
-<summary>Using different environment variables</summary>
-
-To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program.  For example:  
-
-```bash
-
-AUTH='{ "aws": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}'
-stackql shell --auth="${AUTH}"
-
-```
-or using PowerShell:  
-
-```powershell
-
-$Auth = "{ 'aws': { 'type': 'aws_signing_v4',  'keyIDenvvar': 'YOUR_ACCESS_KEY_ID_VAR', 'credentialsenvvar': 'YOUR_SECRET_KEY_VAR' }}"
-stackql.exe shell --auth=$Auth
-
-```
-</details>
-
-
-## Server Parameters
-
-
-The following parameter is required for the `aws` provider:  
-
-- <CopyableCode code="region" /> - AWS region (e.g. <code>us-east-1</code>)
-
+See also:   
+[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe)  [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
+* * * 
+
+## Installation
+
+To pull the latest version of the `aws` provider, run the following command:  
+
+```bash
+REGISTRY PULL aws;
+```
+> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).  
+
+## Authentication
+
+The following system environment variables are used for authentication by default:  
+
+- <CopyableCode code="AWS_ACCESS_KEY_ID" /> - AWS Access Key ID (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html">How to Create AWS Credentials</a>)
+- <CopyableCode code="AWS_SECRET_ACCESS_KEY" /> - AWS Secret Access Key (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html">How to Create AWS Credentials</a>)
+- <CopyableCode code="AWS_SESSION_TOKEN" /> - [<i>OPTIONAL:</i> only required if using <CopyableCode code="aws sts assume-role" />] AWS Session Token (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary security credentials in IAM</a>)
+
+These variables are sourced at runtime (from the local machine or as CI variables/secrets).  
+
+<details>
+
+<summary>Using different environment variables</summary>
+
+To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program.  For example:  
+
+```bash
+
+AUTH='{ "aws": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}'
+stackql shell --auth="${AUTH}"
+
+```
+or using PowerShell:  
+
+```powershell
+
+$Auth = "{ 'aws': { 'type': 'aws_signing_v4',  'keyIDenvvar': 'YOUR_ACCESS_KEY_ID_VAR', 'credentialsenvvar': 'YOUR_SECRET_KEY_VAR' }}"
+stackql.exe shell --auth=$Auth
+
+```
+</details>
+
+
+## Server Parameters
+
+
+The following parameter is required for the `aws` provider:  
+
+- <CopyableCode code="region" /> - AWS region (e.g. <code>us-east-1</code>)
+
 This parameter must be supplied to the `WHERE` clause of each `SELECT` statement.
 
 ## Services
@@ -313,3 +313,4 @@ This parameter must be supplied to the `WHERE` clause of each `SELECT` statement
 <a href="/providers/aws/xray/">xray</a><br />
 </div>
 </div>
+