Skip to content

Commit

Permalink
Merge pull request #128 from stackql/feature/doc-updates
Browse files Browse the repository at this point in the history
awscc updates
  • Loading branch information
jeffreyaven authored Mar 7, 2024
2 parents 7c467e1 + 1d26d06 commit 0d2c597
Show file tree
Hide file tree
Showing 1,697 changed files with 12,255 additions and 8,276 deletions.
2 changes: 1 addition & 1 deletion ci-scripts/get-providers-to-deploy.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ module.exports = async ({ github, context, core, pathOutput }) => {

// if(!(diff.startsWith('.github')) || !(diff.startsWith('scripts'))) globalChange = true;

globalChange = true;
globalChange = false;

}).filter(Boolean)

Expand Down
146 changes: 74 additions & 72 deletions docs/awscc-docs/index.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
---
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.
---
title: awscc
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: awscc-doc
slug: /providers/awscc

---
Cloud services from AWS using the Cloud Control API.

:::info Provider Summary (v24.03.00206)

Expand All @@ -32,60 +34,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 `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.
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.

## Services
<div class="row">
Expand Down
15 changes: 9 additions & 6 deletions docs/awscc-docs/providers/awscc/accessanalyzer/analyzer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,23 +45,26 @@ Currently only <code>SELECT</code> is supported for this resource resource.
To operate on the <code>analyzer</code> resource, the following permissions are required:

### Read
<pre>
```json
access-analyzer:ListAnalyzers,
access-analyzer:GetAnalyzer,
access-analyzer:ListArchiveRules</pre>
access-analyzer:ListArchiveRules
```

### Update
<pre>
```json
access-analyzer:CreateArchiveRule,
access-analyzer:DeleteArchiveRule,
access-analyzer:ListAnalyzers,
access-analyzer:TagResource,
access-analyzer:UntagResource,
access-analyzer:UpdateArchiveRule</pre>
access-analyzer:UpdateArchiveRule
```

### Delete
<pre>
access-analyzer:DeleteAnalyzer</pre>
```json
access-analyzer:DeleteAnalyzer
```


## Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,18 @@ Currently only <code>SELECT</code> is supported for this resource resource.
To operate on the <code>analyzers</code> resource, the following permissions are required:

### Create
<pre>
```json
access-analyzer:CreateAnalyzer,
access-analyzer:TagResource,
iam:CreateServiceLinkedRole,
organizations:ListAWSServiceAccessForOrganization,
organizations:ListDelegatedAdministrators</pre>
organizations:ListDelegatedAdministrators
```

### List
<pre>
access-analyzer:ListAnalyzers</pre>
```json
access-analyzer:ListAnalyzers
```


## Example
Expand Down
14 changes: 6 additions & 8 deletions docs/awscc-docs/providers/awscc/acmpca/certificate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,14 @@ Currently only <code>SELECT</code> is supported for this resource resource.
To operate on the <code>certificate</code> resource, the following permissions are required:

### Read
<pre>
acm-pca:GetCertificate</pre>
```json
acm-pca:GetCertificate
```

### Delete
<pre>
acm-pca:GetCertificate</pre>

### Update
<pre>
</pre>
```json
acm-pca:GetCertificate
```


## Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,19 @@ Currently only <code>SELECT</code> is supported for this resource resource.
To operate on the <code>certificate_authorities</code> resource, the following permissions are required:

### Create
<pre>
```json
acm-pca:CreateCertificateAuthority,
acm-pca:DescribeCertificateAuthority,
acm-pca:GetCertificateAuthorityCsr</pre>
acm-pca:GetCertificateAuthorityCsr
```

### List
<pre>
```json
acm-pca:DescribeCertificateAuthority,
acm-pca:GetCertificateAuthorityCsr,
acm-pca:ListCertificateAuthorities,
acm-pca:ListTags</pre>
acm-pca:ListTags
```


## Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,22 +50,25 @@ Currently only <code>SELECT</code> is supported for this resource resource.
To operate on the <code>certificate_authority</code> resource, the following permissions are required:

### Read
<pre>
```json
acm-pca:DescribeCertificateAuthority,
acm-pca:GetCertificateAuthorityCsr,
acm-pca:ListTags</pre>
acm-pca:ListTags
```

### Update
<pre>
```json
acm-pca:ListTags,
acm-pca:TagCertificateAuthority,
acm-pca:UntagCertificateAuthority,
acm-pca:UpdateCertificateAuthority</pre>
acm-pca:UpdateCertificateAuthority
```

### Delete
<pre>
```json
acm-pca:DeleteCertificateAuthority,
acm-pca:DescribeCertificateAuthority</pre>
acm-pca:DescribeCertificateAuthority
```


## Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,21 @@ Currently only <code>SELECT</code> is supported for this resource resource.
To operate on the <code>certificate_authority_activation</code> resource, the following permissions are required:

### Read
<pre>
```json
acm-pca:GetCertificateAuthorityCertificate,
acm-pca:DescribeCertificateAuthority</pre>
acm-pca:DescribeCertificateAuthority
```

### Delete
<pre>
acm-pca:UpdateCertificateAuthority</pre>
```json
acm-pca:UpdateCertificateAuthority
```

### Update
<pre>
```json
acm-pca:ImportCertificateAuthorityCertificate,
acm-pca:UpdateCertificateAuthority</pre>
acm-pca:UpdateCertificateAuthority
```


## Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,10 @@ Currently only <code>SELECT</code> is supported for this resource resource.
To operate on the <code>certificate_authority_activations</code> resource, the following permissions are required:

### Create
<pre>
```json
acm-pca:ImportCertificateAuthorityCertificate,
acm-pca:UpdateCertificateAuthority</pre>
acm-pca:UpdateCertificateAuthority
```


## Example
Expand Down
5 changes: 3 additions & 2 deletions docs/awscc-docs/providers/awscc/acmpca/certificates/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,10 @@ Currently only <code>SELECT</code> is supported for this resource resource.
To operate on the <code>certificates</code> resource, the following permissions are required:

### Create
<pre>
```json
acm-pca:IssueCertificate,
acm-pca:GetCertificate</pre>
acm-pca:GetCertificate
```


## Example
Expand Down
10 changes: 6 additions & 4 deletions docs/awscc-docs/providers/awscc/acmpca/permission/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,14 @@ Currently only <code>SELECT</code> is supported for this resource resource.
To operate on the <code>permission</code> resource, the following permissions are required:

### Read
<pre>
acm-pca:ListPermissions</pre>
```json
acm-pca:ListPermissions
```

### Delete
<pre>
acm-pca:DeletePermission</pre>
```json
acm-pca:DeletePermission
```


## Example
Expand Down
5 changes: 3 additions & 2 deletions docs/awscc-docs/providers/awscc/acmpca/permissions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,10 @@ Currently only <code>SELECT</code> is supported for this resource resource.
To operate on the <code>permissions</code> resource, the following permissions are required:

### Create
<pre>
```json
acm-pca:CreatePermission,
acm-pca:ListPermissions</pre>
acm-pca:ListPermissions
```


## Example
Expand Down
Loading

0 comments on commit 0d2c597

Please sign in to comment.