Skip to content

Commit f655add

Browse files
authored
Merge pull request #176 from stackql/feature/doc-updates
updated aws docs
2 parents 6722fd5 + 92a0458 commit f655add

File tree

1 file changed

+76
-75
lines changed

1 file changed

+76
-75
lines changed

docs/aws-docs/index.md

Lines changed: 76 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
---
2-
title: aws
3-
hide_title: false
4-
hide_table_of_contents: false
5-
keywords:
6-
- aws
7-
- aws cloud control
8-
- cloud control api
9-
- stackql
10-
- infrastructure-as-code
11-
- configuration-as-data
12-
- cloud inventory
13-
description: Query, deploy and manage AWS resources using SQL
14-
custom_edit_url: null
15-
image: /img/providers/aws/stackql-aws-provider-featured-image.png
16-
id: aws-doc
17-
slug: /providers/aws
18-
19-
---
20-
21-
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
22-
1+
---
2+
title: aws
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- aws
7+
- aws cloud control
8+
- cloud control api
9+
- stackql
10+
- infrastructure-as-code
11+
- configuration-as-data
12+
- cloud inventory
13+
description: Query, deploy and manage AWS resources using SQL
14+
custom_edit_url: null
15+
image: /img/providers/aws/stackql-aws-provider-featured-image.png
16+
id: aws-doc
17+
slug: /providers/aws
18+
19+
---
20+
21+
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
22+
2323
Cloud services from AWS.
2424

2525
:::info Provider Summary (v24.07.00244)
@@ -33,59 +33,59 @@ Cloud services from AWS.
3333

3434
:::
3535

36-
See also:
37-
[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
38-
* * *
39-
40-
## Installation
41-
42-
To pull the latest version of the `aws` provider, run the following command:
43-
44-
```bash
45-
REGISTRY PULL aws;
46-
```
47-
> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).
48-
49-
## Authentication
50-
51-
The following system environment variables are used for authentication by default:
52-
53-
- <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>)
54-
- <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>)
55-
- <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>)
56-
57-
These variables are sourced at runtime (from the local machine or as CI variables/secrets).
58-
59-
<details>
60-
61-
<summary>Using different environment variables</summary>
62-
63-
To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example:
64-
65-
```bash
66-
67-
AUTH='{ "aws": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}'
68-
stackql shell --auth="${AUTH}"
69-
70-
```
71-
or using PowerShell:
72-
73-
```powershell
74-
75-
$Auth = "{ 'aws': { 'type': 'aws_signing_v4', 'keyIDenvvar': 'YOUR_ACCESS_KEY_ID_VAR', 'credentialsenvvar': 'YOUR_SECRET_KEY_VAR' }}"
76-
stackql.exe shell --auth=$Auth
77-
78-
```
79-
</details>
80-
81-
82-
## Server Parameters
83-
84-
85-
The following parameter is required for the `aws` provider:
86-
87-
- <CopyableCode code="region" /> - AWS region (e.g. <code>us-east-1</code>)
88-
36+
See also:
37+
[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
38+
* * *
39+
40+
## Installation
41+
42+
To pull the latest version of the `aws` provider, run the following command:
43+
44+
```bash
45+
REGISTRY PULL aws;
46+
```
47+
> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).
48+
49+
## Authentication
50+
51+
The following system environment variables are used for authentication by default:
52+
53+
- <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>)
54+
- <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>)
55+
- <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>)
56+
57+
These variables are sourced at runtime (from the local machine or as CI variables/secrets).
58+
59+
<details>
60+
61+
<summary>Using different environment variables</summary>
62+
63+
To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example:
64+
65+
```bash
66+
67+
AUTH='{ "aws": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}'
68+
stackql shell --auth="${AUTH}"
69+
70+
```
71+
or using PowerShell:
72+
73+
```powershell
74+
75+
$Auth = "{ 'aws': { 'type': 'aws_signing_v4', 'keyIDenvvar': 'YOUR_ACCESS_KEY_ID_VAR', 'credentialsenvvar': 'YOUR_SECRET_KEY_VAR' }}"
76+
stackql.exe shell --auth=$Auth
77+
78+
```
79+
</details>
80+
81+
82+
## Server Parameters
83+
84+
85+
The following parameter is required for the `aws` provider:
86+
87+
- <CopyableCode code="region" /> - AWS region (e.g. <code>us-east-1</code>)
88+
8989
This parameter must be supplied to the `WHERE` clause of each `SELECT` statement.
9090

9191
## Services
@@ -313,3 +313,4 @@ This parameter must be supplied to the `WHERE` clause of each `SELECT` statement
313313
<a href="/providers/aws/xray/">xray</a><br />
314314
</div>
315315
</div>
316+

0 commit comments

Comments
 (0)