Skip to content

Commit

Permalink
Merge pull request #169 from stackql/feature/doc-updates
Browse files Browse the repository at this point in the history
updated aws provider index
  • Loading branch information
jeffreyaven authored Jun 11, 2024
2 parents f86ffa4 + 38d9ea1 commit 6167569
Showing 1 changed file with 78 additions and 78 deletions.
156 changes: 78 additions & 78 deletions docs/aws-docs/index.md
Original file line number Diff line number Diff line change
@@ -1,95 +1,95 @@
---
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.06.00240)

<div class="row">
<div class="providerDocColumn">
<span>total services:&nbsp;<b>218</b></span><br />
<span>total methods:&nbsp;<b>57</b></span><br />
<span>total methods:&nbsp;<b>2914</b></span><br />
</div>
<div class="providerDocColumn">
<span>total resources:&nbsp;<b>0</b></span><br />
<span>total selectable resources:&nbsp;<b>-13</b></span><br />
<span>total resources:&nbsp;<b>1013</b></span><br />
<span>total selectable resources:&nbsp;<b>1010</b></span><br />
</div>
</div>

:::

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
Expand Down

0 comments on commit 6167569

Please sign in to comment.