Skip to content

Commit 6722fd5

Browse files
authored
Merge pull request #175 from stackql/feature/doc-updates
Feature/doc updates
2 parents 9674a3f + c002ece commit 6722fd5

File tree

2,763 files changed

+135243
-5298
lines changed

Some content is hidden

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

2,763 files changed

+135243
-5298
lines changed

docs/aws-docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
2222

2323
Cloud services from AWS.
2424

25-
:::info Provider Summary (v24.06.00240)
25+
:::info Provider Summary (v24.07.00244)
2626

2727
<div class="row">
2828
<div class="providerDocColumn">
2929
<span>total services:&nbsp;<b>218</b></span><br />
30-
<span>total resources:&nbsp;<b>1013</b></span><br />
30+
<span>total resources:&nbsp;<b>2548</b></span><br />
3131
</div>
3232
</div>
3333

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: analyzer_tags
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- analyzer_tags
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+
18+
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
19+
import Tabs from '@theme/Tabs';
20+
import TabItem from '@theme/TabItem';
21+
22+
Expands all tag keys and values for <code>analyzers</code> in a region
23+
24+
## Overview
25+
<table><tbody>
26+
<tr><td><b>Name</b></td><td><code>analyzer_tags</code></td></tr>
27+
<tr><td><b>Type</b></td><td>Resource</td></tr>
28+
<tr><td><b>Description</b></td><td>The AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account</td></tr>
29+
<tr><td><b>Id</b></td><td><CopyableCode code="aws.accessanalyzer.analyzer_tags" /></td></tr>
30+
</tbody></table>
31+
32+
## Fields
33+
<table><tbody><tr><th>Name</th><th>Datatype</th><th>Description</th></tr><tr><td><CopyableCode code="analyzer_name" /></td><td><code>string</code></td><td>Analyzer name</td></tr>
34+
<tr><td><CopyableCode code="archive_rules" /></td><td><code>array</code></td><td></td></tr>
35+
<tr><td><CopyableCode code="arn" /></td><td><code>string</code></td><td>Amazon Resource Name (ARN) of the analyzer</td></tr>
36+
<tr><td><CopyableCode code="type" /></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>
37+
<tr><td><CopyableCode code="analyzer_configuration" /></td><td><code>object</code></td><td>The configuration for the analyzer</td></tr>
38+
<tr><td><CopyableCode code="tag_key" /></td><td><code>string</code></td><td>Tag key.</td></tr>
39+
<tr><td><CopyableCode code="tag_value" /></td><td><code>string</code></td><td>Tag value.</td></tr>
40+
<tr><td><CopyableCode code="region" /></td><td><code>string</code></td><td>AWS region.</td></tr>
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><CopyableCode code="list_resources" /></td>
53+
<td><code>SELECT</code></td>
54+
<td><CopyableCode code="region" /></td>
55+
</tr>
56+
</tbody></table>
57+
58+
## `SELECT` examples
59+
Expands tags for all <code>analyzers</code> in a region.
60+
```sql
61+
SELECT
62+
region,
63+
analyzer_name,
64+
archive_rules,
65+
arn,
66+
type,
67+
analyzer_configuration,
68+
tag_key,
69+
tag_value
70+
FROM aws.accessanalyzer.analyzer_tags
71+
WHERE region = 'us-east-1';
72+
```
73+
74+
75+
## Permissions
76+
77+
For permissions required to operate on the <code>analyzer_tags</code> resource, see <a href="/providers/aws/accessanalyzer/analyzers/#permissions"><code>analyzers</code></a>
78+
79+

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

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Creates, updates, deletes or gets an <code>analyzer</code> resource or lists <co
6363
<td><CopyableCode code="data__Identifier, data__PatchDocument, region" /></td>
6464
</tr>
6565
<tr>
66-
<td><CopyableCode code="list_resource" /></td>
66+
<td><CopyableCode code="list_resources" /></td>
6767
<td><code>SELECT</code></td>
6868
<td><CopyableCode code="region" /></td>
6969
</tr>
@@ -75,15 +75,20 @@ Creates, updates, deletes or gets an <code>analyzer</code> resource or lists <co
7575
</tbody></table>
7676

7777
## `SELECT` examples
78-
List all <code>analyzers</code> in a region.
78+
Gets all <code>analyzers</code> in a region.
7979
```sql
8080
SELECT
8181
region,
82-
arn
82+
analyzer_name,
83+
archive_rules,
84+
arn,
85+
tags,
86+
type,
87+
analyzer_configuration
8388
FROM aws.accessanalyzer.analyzers
8489
WHERE region = 'us-east-1';
8590
```
86-
Gets all properties from an <code>analyzer</code>.
91+
Gets all properties from an individual <code>analyzer</code>.
8792
```sql
8893
SELECT
8994
region,
@@ -97,7 +102,6 @@ FROM aws.accessanalyzer.analyzers
97102
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';
98103
```
99104

100-
101105
## `INSERT` example
102106

103107
Use the following StackQL query and manifest file to create a new <code>analyzer</code> resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/).
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: analyzers_list_only
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- analyzers_list_only
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+
18+
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
19+
import Tabs from '@theme/Tabs';
20+
import TabItem from '@theme/TabItem';
21+
22+
Lists <code>analyzers</code> in a region or regions, for all properties use <a href="/providers/aws/serviceName/analyzers/"><code>analyzers</code></a>
23+
24+
## Overview
25+
<table><tbody>
26+
<tr><td><b>Name</b></td><td><code>analyzers_list_only</code></td></tr>
27+
<tr><td><b>Type</b></td><td>Resource</td></tr>
28+
<tr><td><b>Description</b></td><td>The AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account</td></tr>
29+
<tr><td><b>Id</b></td><td><CopyableCode code="aws.accessanalyzer.analyzers_list_only" /></td></tr>
30+
</tbody></table>
31+
32+
## Fields
33+
<table><tbody><tr><th>Name</th><th>Datatype</th><th>Description</th></tr><tr><td><CopyableCode code="analyzer_name" /></td><td><code>string</code></td><td>Analyzer name</td></tr>
34+
<tr><td><CopyableCode code="archive_rules" /></td><td><code>array</code></td><td></td></tr>
35+
<tr><td><CopyableCode code="arn" /></td><td><code>string</code></td><td>Amazon Resource Name (ARN) of the analyzer</td></tr>
36+
<tr><td><CopyableCode code="tags" /></td><td><code>array</code></td><td>An array of key-value pairs to apply to this resource.</td></tr>
37+
<tr><td><CopyableCode code="type" /></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>
38+
<tr><td><CopyableCode code="analyzer_configuration" /></td><td><code>object</code></td><td>The configuration for the analyzer</td></tr>
39+
<tr><td><CopyableCode code="region" /></td><td><code>string</code></td><td>AWS region.</td></tr>
40+
</tbody></table>
41+
42+
## Methods
43+
44+
<table><tbody>
45+
<tr>
46+
<th>Name</th>
47+
<th>Accessible by</th>
48+
<th>Required Params</th>
49+
</tr>
50+
<tr>
51+
<td><CopyableCode code="list_resources" /></td>
52+
<td><code>SELECT</code></td>
53+
<td><CopyableCode code="region" /></td>
54+
</tr>
55+
</tbody></table>
56+
57+
## `SELECT` examples
58+
Lists all <code>analyzers</code> in a region.
59+
```sql
60+
SELECT
61+
region,
62+
arn
63+
FROM aws.accessanalyzer.analyzers_list_only
64+
WHERE region = 'us-east-1';
65+
```
66+
67+
68+
## Permissions
69+
70+
For permissions required to operate on the <code>analyzers_list_only</code> resource, see <a href="/providers/aws/accessanalyzer/analyzers/#permissions"><code>analyzers</code></a>
71+
72+

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The accessanalyzer service documentation.
2020

2121
<div class="row">
2222
<div class="providerDocColumn">
23-
<span>total resources:&nbsp;<b>1</b></span><br />
23+
<span>total resources:&nbsp;<b>3</b></span><br />
2424
</div>
2525
</div>
2626

@@ -29,9 +29,10 @@ The accessanalyzer service documentation.
2929
## Resources
3030
<div class="row">
3131
<div class="providerDocColumn">
32+
<a href="/providers/aws/accessanalyzer/analyzer_tags/">analyzer_tags</a><br />
3233
<a href="/providers/aws/accessanalyzer/analyzers/">analyzers</a>
3334
</div>
3435
<div class="providerDocColumn">
35-
36+
<a href="/providers/aws/accessanalyzer/analyzers_list_only/">analyzers_list_only</a>
3637
</div>
3738
</div>

docs/aws-docs/providers/aws/acmpca/certificate_authorities/index.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Creates, updates, deletes or gets a <code>certificate_authority</code> resource
6868
<td><CopyableCode code="data__Identifier, data__PatchDocument, region" /></td>
6969
</tr>
7070
<tr>
71-
<td><CopyableCode code="list_resource" /></td>
71+
<td><CopyableCode code="list_resources" /></td>
7272
<td><code>SELECT</code></td>
7373
<td><CopyableCode code="region" /></td>
7474
</tr>
@@ -80,15 +80,25 @@ Creates, updates, deletes or gets a <code>certificate_authority</code> resource
8080
</tbody></table>
8181

8282
## `SELECT` examples
83-
List all <code>certificate_authorities</code> in a region.
83+
Gets all <code>certificate_authorities</code> in a region.
8484
```sql
8585
SELECT
8686
region,
87-
arn
87+
arn,
88+
type,
89+
key_algorithm,
90+
signing_algorithm,
91+
subject,
92+
revocation_configuration,
93+
tags,
94+
certificate_signing_request,
95+
csr_extensions,
96+
key_storage_security_standard,
97+
usage_mode
8898
FROM aws.acmpca.certificate_authorities
8999
WHERE region = 'us-east-1';
90100
```
91-
Gets all properties from a <code>certificate_authority</code>.
101+
Gets all properties from an individual <code>certificate_authority</code>.
92102
```sql
93103
SELECT
94104
region,
@@ -107,7 +117,6 @@ FROM aws.acmpca.certificate_authorities
107117
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';
108118
```
109119

110-
111120
## `INSERT` example
112121

113122
Use the following StackQL query and manifest file to create a new <code>certificate_authority</code> resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/).
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
title: certificate_authorities_list_only
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- certificate_authorities_list_only
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+
18+
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
19+
import Tabs from '@theme/Tabs';
20+
import TabItem from '@theme/TabItem';
21+
22+
Lists <code>certificate_authorities</code> in a region or regions, for all properties use <a href="/providers/aws/serviceName/certificate_authorities/"><code>certificate_authorities</code></a>
23+
24+
## Overview
25+
<table><tbody>
26+
<tr><td><b>Name</b></td><td><code>certificate_authorities_list_only</code></td></tr>
27+
<tr><td><b>Type</b></td><td>Resource</td></tr>
28+
<tr><td><b>Description</b></td><td>Private certificate authority.</td></tr>
29+
<tr><td><b>Id</b></td><td><CopyableCode code="aws.acmpca.certificate_authorities_list_only" /></td></tr>
30+
</tbody></table>
31+
32+
## Fields
33+
<table><tbody><tr><th>Name</th><th>Datatype</th><th>Description</th></tr><tr><td><CopyableCode code="arn" /></td><td><code>string</code></td><td>The Amazon Resource Name (ARN) of the certificate authority.</td></tr>
34+
<tr><td><CopyableCode code="type" /></td><td><code>string</code></td><td>The type of the certificate authority.</td></tr>
35+
<tr><td><CopyableCode code="key_algorithm" /></td><td><code>string</code></td><td>Public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.</td></tr>
36+
<tr><td><CopyableCode code="signing_algorithm" /></td><td><code>string</code></td><td>Algorithm your CA uses to sign certificate requests.</td></tr>
37+
<tr><td><CopyableCode code="subject" /></td><td><code>object</code></td><td>Structure that contains X.500 distinguished name information for your CA.</td></tr>
38+
<tr><td><CopyableCode code="revocation_configuration" /></td><td><code>object</code></td><td>Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions.</td></tr>
39+
<tr><td><CopyableCode code="tags" /></td><td><code>array</code></td><td></td></tr>
40+
<tr><td><CopyableCode code="certificate_signing_request" /></td><td><code>string</code></td><td>The base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate.</td></tr>
41+
<tr><td><CopyableCode code="csr_extensions" /></td><td><code>object</code></td><td>Structure that contains CSR pass through extension information used by the CreateCertificateAuthority action.</td></tr>
42+
<tr><td><CopyableCode code="key_storage_security_standard" /></td><td><code>string</code></td><td>KeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys.</td></tr>
43+
<tr><td><CopyableCode code="usage_mode" /></td><td><code>string</code></td><td>Usage mode of the ceritificate authority.</td></tr>
44+
<tr><td><CopyableCode code="region" /></td><td><code>string</code></td><td>AWS region.</td></tr>
45+
</tbody></table>
46+
47+
## Methods
48+
49+
<table><tbody>
50+
<tr>
51+
<th>Name</th>
52+
<th>Accessible by</th>
53+
<th>Required Params</th>
54+
</tr>
55+
<tr>
56+
<td><CopyableCode code="list_resources" /></td>
57+
<td><code>SELECT</code></td>
58+
<td><CopyableCode code="region" /></td>
59+
</tr>
60+
</tbody></table>
61+
62+
## `SELECT` examples
63+
Lists all <code>certificate_authorities</code> in a region.
64+
```sql
65+
SELECT
66+
region,
67+
arn
68+
FROM aws.acmpca.certificate_authorities_list_only
69+
WHERE region = 'us-east-1';
70+
```
71+
72+
73+
## Permissions
74+
75+
For permissions required to operate on the <code>certificate_authorities_list_only</code> resource, see <a href="/providers/aws/acmpca/certificate_authorities/#permissions"><code>certificate_authorities</code></a>
76+
77+

docs/aws-docs/providers/aws/acmpca/certificate_authority_activations/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Creates, updates, deletes or gets a <code>certificate_authority_activation</code
7070

7171
## `SELECT` examples
7272

73-
Gets all properties from a <code>certificate_authority_activation</code>.
73+
Gets all properties from an individual <code>certificate_authority_activation</code>.
7474
```sql
7575
SELECT
7676
region,
@@ -83,7 +83,6 @@ FROM aws.acmpca.certificate_authority_activations
8383
WHERE region = 'us-east-1' AND data__Identifier = '<CertificateAuthorityArn>';
8484
```
8585

86-
8786
## `INSERT` example
8887

8988
Use the following StackQL query and manifest file to create a new <code>certificate_authority_activation</code> resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/).

0 commit comments

Comments
 (0)