Skip to content

Commit 0403b7e

Browse files
jeffreyavenjeffreyaven
authored
Merge pull request #138 from stackql/feature/doc-updates
Feature/doc updates
2 parents df78d1b + 2c55465 commit 0403b7e

File tree

4,761 files changed

+203702
-157650
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

4,761 files changed

+203702
-157650
lines changed

‎.github/workflows/build-docs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ jobs:
7878
if [ $PROVIDER == "root" ]; then
7979
echo "adding vanity url redirects to _redirects file.."
8080
touch ./build/_redirects
81-
array=( aws awscc azure azure-extras azure-isv azure-stack digitalocean firebase github google googleadmin k8s linode netlify okta sumologic vercel godaddy pagerduty homebrew datadog )
81+
array=( aws azure azure-extras azure-isv azure-stack digitalocean firebase github google googleadmin k8s linode netlify okta sumologic vercel godaddy pagerduty homebrew datadog )
8282
for i in "${array[@]}"
8383
do
8484
echo "adding redirects for $i"

‎README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ This repository contains documentation for StackQL providers, which is published
2727
| Netlify Deploy Datadog | [![Netlify Status](https://api.netlify.com/api/v1/badges/9e76122d-09bd-4938-a50f-3b4196e94f0c/deploy-status)](https://app.netlify.com/sites/stackql-datadog-docs/deploys) | [datadog-docs.stackql.io](https://datadog-docs.stackql.io)<br/>[datadog.stackql.io](https://datadog.stackql.io) |
2828
| Netlify Deploy Azure ISV | [![Netlify Status](https://api.netlify.com/api/v1/badges/35fc840c-0494-462f-9b3f-cbd3418a3c78/deploy-status)](https://app.netlify.com/sites/stackql-azure-isv-docs/deploys) | [azure-isv-docs.stackql.io](https://azure-isv-docs.stackql.io)<br/>[azure-isv.stackql.io](https://azure-isv.stackql.io) |
2929
| Netlify Deploy Azure Stack | [![Netlify Status](https://api.netlify.com/api/v1/badges/53abcb20-0194-41dd-b466-4d933cfffcad/deploy-status)](https://app.netlify.com/sites/stackql-azure-stack-docs/deploys) | [azure-stack-docs.stackql.io](https://azure-stack-docs.stackql.io)<br/>[azure-stack.stackql.io](https://azure-stack.stackql.io) |
30-
| Netlify Deploy AWS Cloud Control | [![Netlify Status](https://api.netlify.com/api/v1/badges/b214d7f4-4c43-43b5-a584-19d2d18902f1/deploy-status)](https://app.netlify.com/sites/stackql-awscc-docs/deploys) | [awscc-docs.stackql.io](https://awscc-docs.stackql.io)<br/>[awscc.stackql.io](https://awscc.stackql.io) |
3130

3231

3332
## Adding Docs for a New Provider

‎ci-scripts/get-providers-to-deploy.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ const isMatchRegex = (path) => regex.test(path);
88
const rootName = 'root'
99
const allProviders = [
1010
'aws',
11-
'awscc',
1211
'azure',
1312
'azure_extras',
1413
'azure_isv',
@@ -53,7 +52,7 @@ module.exports = async ({ github, context, core, pathOutput }) => {
5352

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

56-
globalChange = false;
55+
globalChange = true;
5756

5857
}).filter(Boolean)
5958

‎docs/aws-docs/index.md

Lines changed: 296 additions & 84 deletions
Large diffs are not rendered by default.

‎docs/aws-docs/providers/aws/accessanalyzer/analyzer/index.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: analyzer
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- analyzer
7+
- accessanalyzer
8+
- aws
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+
---
17+
Gets an individual <code>analyzer</code> resource
18+
19+
## Overview
20+
<table><tbody>
21+
<tr><td><b>Name</b></td><td><code>analyzer</code></td></tr>
22+
<tr><td><b>Type</b></td><td>Resource</td></tr>
23+
<tr><td><b>Description</b></td><td>The AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account</td></tr>
24+
<tr><td><b>Id</b></td><td><code>aws.accessanalyzer.analyzer</code></td></tr>
25+
</tbody></table>
26+
27+
## Fields
28+
<table><tbody>
29+
<tr><th>Name</th><th>Datatype</th><th>Description</th></tr>
30+
<tr><td><code>analyzer_name</code></td><td><code>string</code></td><td>Analyzer name</td></tr>
31+
<tr><td><code>archive_rules</code></td><td><code>array</code></td><td></td></tr>
32+
<tr><td><code>arn</code></td><td><code>string</code></td><td>Amazon Resource Name (ARN) of the analyzer</td></tr>
33+
<tr><td><code>tags</code></td><td><code>array</code></td><td>An array of key-value pairs to apply to this resource.</td></tr>
34+
<tr><td><code>type</code></td><td><code>string</code></td><td>The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS</td></tr>
35+
<tr><td><code>analyzer_configuration</code></td><td><code>object</code></td><td>The configuration for the analyzer</td></tr>
36+
<tr><td><code>region</code></td><td><code>string</code></td><td>AWS region.</td></tr>
37+
38+
</tbody></table>
39+
40+
## Methods
41+
42+
<table><tbody>
43+
<tr>
44+
<th>Name</th>
45+
<th>Accessible by</th>
46+
<th>Required Params</th>
47+
</tr>
48+
<tr>
49+
<td><code>update_resource</code></td>
50+
<td><code>UPDATE</code></td>
51+
<td><code>data__Identifier, data__PatchDocument, region</code></td>
52+
</tr>
53+
<tr>
54+
<td><code>delete_resource</code></td>
55+
<td><code>DELETE</code></td>
56+
<td><code>data__Identifier, region</code></td>
57+
</tr>
58+
<tr>
59+
<td><code>get_resource</code></td>
60+
<td><code>SELECT</code></td>
61+
<td><code>data__Identifier, region</code></td>
62+
</tr>
63+
</tbody></table>
64+
65+
## `SELECT` Example
66+
```sql
67+
SELECT
68+
region,
69+
analyzer_name,
70+
archive_rules,
71+
arn,
72+
tags,
73+
type,
74+
analyzer_configuration
75+
FROM aws.accessanalyzer.analyzer
76+
WHERE data__Identifier = '<Arn>';
77+
```
78+
79+
## Permissions
80+
81+
To operate on the <code>analyzer</code> resource, the following permissions are required:
82+
83+
### Read
84+
```json
85+
access-analyzer:ListAnalyzers,
86+
access-analyzer:GetAnalyzer,
87+
access-analyzer:ListArchiveRules
88+
```
89+
90+
### Update
91+
```json
92+
access-analyzer:CreateArchiveRule,
93+
access-analyzer:DeleteArchiveRule,
94+
access-analyzer:ListAnalyzers,
95+
access-analyzer:TagResource,
96+
access-analyzer:UntagResource,
97+
access-analyzer:UpdateArchiveRule
98+
```
99+
100+
### Delete
101+
```json
102+
access-analyzer:DeleteAnalyzer
103+
```
104+

‎docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
title: analyzers
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- analyzers
7+
- accessanalyzer
8+
- aws
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+
---
17+
Retrieves a list of <code>analyzers</code> in a region
18+
19+
## Overview
20+
<table><tbody>
21+
<tr><td><b>Name</b></td><td><code>analyzers</code></td></tr>
22+
<tr><td><b>Type</b></td><td>Resource</td></tr>
23+
<tr><td><b>Description</b></td><td>The AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account</td></tr>
24+
<tr><td><b>Id</b></td><td><code>aws.accessanalyzer.analyzers</code></td></tr>
25+
</tbody></table>
26+
27+
## Fields
28+
<table><tbody>
29+
<tr><th>Name</th><th>Datatype</th><th>Description</th></tr>
30+
<tr><td><code>arn</code></td><td><code>string</code></td><td>Amazon Resource Name (ARN) of the analyzer</td></tr>
31+
<tr><td><code>region</code></td><td><code>string</code></td><td>AWS region.</td></tr>
32+
33+
</tbody></table>
34+
35+
## Methods
36+
37+
<table><tbody>
38+
<tr>
39+
<th>Name</th>
40+
<th>Accessible by</th>
41+
<th>Required Params</th>
42+
</tr>
43+
<tr>
44+
<td><code>create_resource</code></td>
45+
<td><code>INSERT</code></td>
46+
<td><code>data__DesiredState, region</code></td>
47+
</tr>
48+
<tr>
49+
<td><code>list_resource</code></td>
50+
<td><code>SELECT</code></td>
51+
<td><code>region</code></td>
52+
</tr>
53+
</tbody></table>
54+
55+
## `SELECT` Example
56+
```sql
57+
SELECT
58+
region,
59+
arn
60+
FROM aws.accessanalyzer.analyzers
61+
WHERE region = 'us-east-1'
62+
```
63+
64+
## Permissions
65+
66+
To operate on the <code>analyzers</code> resource, the following permissions are required:
67+
68+
### Create
69+
```json
70+
access-analyzer:CreateAnalyzer,
71+
access-analyzer:TagResource,
72+
iam:CreateServiceLinkedRole,
73+
organizations:ListAWSServiceAccessForOrganization,
74+
organizations:ListDelegatedAdministrators
75+
```
76+
77+
### List
78+
```json
79+
access-analyzer:ListAnalyzers
80+
```
81+

‎docs/aws-docs/providers/aws/accessanalyzer/index.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: accessanalyzer
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- accessanalyzer
7+
- aws
8+
- stackql
9+
- infrastructure-as-code
10+
- configuration-as-data
11+
- cloud inventory
12+
description: Query, deploy and manage AWS resources using SQL
13+
custom_edit_url: null
14+
image: /img/providers/aws/stackql-aws-provider-featured-image.png
15+
---
16+
17+
The accessanalyzer service documentation.
18+
19+
:::info Service Summary
20+
21+
<div class="row">
22+
<div class="providerDocColumn">
23+
<span>total resources:&nbsp;<b>2</b></span><br />
24+
<span>total selectable resources:&nbsp;<b>2</b></span><br />
25+
<span>total methods:&nbsp;<b>2</b></span><br />
26+
</div>
27+
</div>
28+
29+
:::
30+
31+
## Resources
32+
<div class="row">
33+
<div class="providerDocColumn">
34+
<a href="/providers/aws/accessanalyzer/analyzer/">analyzer</a>
35+
</div>
36+
<div class="providerDocColumn">
37+
<a href="/providers/aws/accessanalyzer/analyzers/">analyzers</a>
38+
</div>
39+
</div>

‎docs/aws-docs/providers/aws/acmpca/certificate/index.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: certificate
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- certificate
7+
- acmpca
8+
- aws
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+
---
17+
Gets an individual <code>certificate</code> resource
18+
19+
## Overview
20+
<table><tbody>
21+
<tr><td><b>Name</b></td><td><code>certificate</code></td></tr>
22+
<tr><td><b>Type</b></td><td>Resource</td></tr>
23+
<tr><td><b>Description</b></td><td>The ``AWS::ACMPCA::Certificate`` resource is used to issue a certificate using your private certificate authority. For more information, see the &#91;IssueCertificate&#93;(https:&#x2F;&#x2F;docs.aws.amazon.com&#x2F;privateca&#x2F;latest&#x2F;APIReference&#x2F;API_IssueCertificate.html) action.</td></tr>
24+
<tr><td><b>Id</b></td><td><code>aws.acmpca.certificate</code></td></tr>
25+
</tbody></table>
26+
27+
## Fields
28+
<table><tbody>
29+
<tr><th>Name</th><th>Datatype</th><th>Description</th></tr>
30+
<tr><td><code>api_passthrough</code></td><td><code>object</code></td><td>Specifies X.509 certificate information to be included in the issued certificate. An ``APIPassthrough`` or ``APICSRPassthrough`` template variant must be selected, or else this parameter is ignored.</td></tr>
31+
<tr><td><code>certificate_authority_arn</code></td><td><code>string</code></td><td>The Amazon Resource Name (ARN) for the private CA issues the certificate.</td></tr>
32+
<tr><td><code>certificate_signing_request</code></td><td><code>string</code></td><td>The certificate signing request (CSR) for the certificate.</td></tr>
33+
<tr><td><code>signing_algorithm</code></td><td><code>string</code></td><td>The name of the algorithm that will be used to sign the certificate to be issued. &lt;br&#x2F;&gt; This parameter should not be confused with the ``SigningAlgorithm`` parameter used to sign a CSR in the ``CreateCertificateAuthority`` action.&lt;br&#x2F;&gt; The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.</td></tr>
34+
<tr><td><code>template_arn</code></td><td><code>string</code></td><td>Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, PCAshort defaults to the ``EndEntityCertificate&#x2F;V1`` template. For more information about PCAshort templates, see &#91;Using Templates&#93;(https:&#x2F;&#x2F;docs.aws.amazon.com&#x2F;privateca&#x2F;latest&#x2F;userguide&#x2F;UsingTemplates.html).</td></tr>
35+
<tr><td><code>validity</code></td><td><code>object</code></td><td>The period of time during which the certificate will be valid.</td></tr>
36+
<tr><td><code>validity_not_before</code></td><td><code>object</code></td><td>Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.&lt;br&#x2F;&gt; By default, when issuing a certificate, PCAshort sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ``ValidityNotBefore`` parameter can be used to customize the “Not Before” value. &lt;br&#x2F;&gt; Unlike the ``Validity`` parameter, the ``ValidityNotBefore`` parameter is optional.&lt;br&#x2F;&gt; The ``ValidityNotBefore`` value is expressed as an explicit date and time, using the ``Validity`` type value ``ABSOLUTE``.</td></tr>
37+
<tr><td><code>certificate</code></td><td><code>string</code></td><td></td></tr>
38+
<tr><td><code>arn</code></td><td><code>string</code></td><td></td></tr>
39+
<tr><td><code>region</code></td><td><code>string</code></td><td>AWS region.</td></tr>
40+
41+
</tbody></table>
42+
43+
## Methods
44+
45+
<table><tbody>
46+
<tr>
47+
<th>Name</th>
48+
<th>Accessible by</th>
49+
<th>Required Params</th>
50+
</tr>
51+
<tr>
52+
<td><code>update_resource</code></td>
53+
<td><code>UPDATE</code></td>
54+
<td><code>data__Identifier, data__PatchDocument, region</code></td>
55+
</tr>
56+
<tr>
57+
<td><code>delete_resource</code></td>
58+
<td><code>DELETE</code></td>
59+
<td><code>data__Identifier, region</code></td>
60+
</tr>
61+
<tr>
62+
<td><code>get_resource</code></td>
63+
<td><code>SELECT</code></td>
64+
<td><code>data__Identifier, region</code></td>
65+
</tr>
66+
</tbody></table>
67+
68+
## `SELECT` Example
69+
```sql
70+
SELECT
71+
region,
72+
api_passthrough,
73+
certificate_authority_arn,
74+
certificate_signing_request,
75+
signing_algorithm,
76+
template_arn,
77+
validity,
78+
validity_not_before,
79+
certificate,
80+
arn
81+
FROM aws.acmpca.certificate
82+
WHERE data__Identifier = '<Arn>|<CertificateAuthorityArn>';
83+
```
84+
85+
## Permissions
86+
87+
To operate on the <code>certificate</code> resource, the following permissions are required:
88+
89+
### Read
90+
```json
91+
acm-pca:GetCertificate
92+
```
93+
94+
### Delete
95+
```json
96+
acm-pca:GetCertificate
97+
```
98+

0 commit comments

Comments
 (0)