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

awscc updates

.github/workflows/build-docs.yaml

@@ -10,7 +10,7 @@ jobs:
     outputs: 
       providers: ${{ steps.provider-to-deploy.outputs.provider_to_deploy }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4.1.1
         with:
           fetch-depth: 0
 
@@ -60,7 +60,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.1
 
       - name: install
         run:

docs/aws-docs/index.md

@@ -1,20 +1,20 @@
----
-title: aws
-hide_title: false
-hide_table_of_contents: false
-keywords:
-  - aws
-  - 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
-
----
+---
+title: aws
+hide_title: false
+hide_table_of_contents: false
+keywords:
+  - aws
+  - 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
+
+---
 Cloud services from AWS.
 
 :::info Provider Summary (v23.11.00181)
@@ -32,58 +32,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:  
-
-- `AWS_ACCESS_KEY_ID` - AWS Access Key ID (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
-- `AWS_SECRET_ACCESS_KEY` - AWS Secret Access Key (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
-
-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:  
-
-- `region` - AWS region (e.g. `us-east-1`)
-
+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:  
+
+- `AWS_ACCESS_KEY_ID` - AWS Access Key ID (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
+- `AWS_SECRET_ACCESS_KEY` - AWS Secret Access Key (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
+- `AWS_SESSION_TOKEN` - [__OPTIONAL:__ only required if using `aws sts assume-role`] AWS Session Token (see [Temporary security credentials in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html))
+
+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:  
+
+- `region` - AWS region (e.g. `us-east-1`)
+
 This parameter must be supplied to the `WHERE` clause of each `SELECT` statement.
 
 ## Services

docs/awscc-docs/index.md

@@ -1,20 +1,20 @@
----
-title: aws
-hide_title: false
-hide_table_of_contents: false
-keywords:
-  - aws
-  - 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
-
----
+---
+title: awscc
+hide_title: false
+hide_table_of_contents: false
+keywords:
+  - aws
+  - 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: awscc-doc
+slug: /providers/awscc
+
+---
 Cloud services from AWS.
 
 :::info Provider Summary (v24.03.00206)
@@ -32,59 +32,60 @@ 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:  
-
-- `AWS_ACCESS_KEY_ID` - AWS Access Key ID (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
-- `AWS_SECRET_ACCESS_KEY` - AWS Secret Access Key (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
-
-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:  
-
-- `region` - AWS region (e.g. `us-east-1`)
-
-This parameter must be supplied to the `WHERE` clause of each `SELECT` statement.
+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 `awscc` provider, run the following command:  
+
+```bash
+REGISTRY PULL awscc;
+```
+> 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:  
+
+- `AWS_ACCESS_KEY_ID` - AWS Access Key ID (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
+- `AWS_SECRET_ACCESS_KEY` - AWS Secret Access Key (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
+- `AWS_SESSION_TOKEN` - [__OPTIONAL:__ only required if using `aws sts assume-role`] AWS Session Token (see [Temporary security credentials in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html))
+
+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='{ "awscc": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}'
+stackql shell --auth="${AUTH}"
+
+```
+or using PowerShell:  
+
+```powershell
+
+$Auth = "{ 'awscc': { '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 `awscc` provider:  
+
+- `region` - AWS region (e.g. `us-east-1`)
+
+This parameter must be supplied to the `WHERE` clause of each `SELECT` statement, with the exception of global services such as `iam`, `route53`, `cloudfront`, etc.
 
 ## Services
 <div class="row">