-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #175 from stackql/feature/doc-updates
Feature/doc updates
- Loading branch information
Showing
2,763 changed files
with
135,243 additions
and
5,298 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
79 changes: 79 additions & 0 deletions
79
docs/aws-docs/providers/aws/accessanalyzer/analyzer_tags/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| --- | ||
| title: analyzer_tags | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - analyzer_tags | ||
| - accessanalyzer | ||
| - 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 | ||
| --- | ||
|
|
||
| import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | ||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| Expands all tag keys and values for <code>analyzers</code> in a region | ||
|
|
||
| ## Overview | ||
| <table><tbody> | ||
| <tr><td><b>Name</b></td><td><code>analyzer_tags</code></td></tr> | ||
| <tr><td><b>Type</b></td><td>Resource</td></tr> | ||
| <tr><td><b>Description</b></td><td>The AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account</td></tr> | ||
| <tr><td><b>Id</b></td><td><CopyableCode code="aws.accessanalyzer.analyzer_tags" /></td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Fields | ||
| <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> | ||
| <tr><td><CopyableCode code="archive_rules" /></td><td><code>array</code></td><td></td></tr> | ||
| <tr><td><CopyableCode code="arn" /></td><td><code>string</code></td><td>Amazon Resource Name (ARN) of the analyzer</td></tr> | ||
| <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> | ||
| <tr><td><CopyableCode code="analyzer_configuration" /></td><td><code>object</code></td><td>The configuration for the analyzer</td></tr> | ||
| <tr><td><CopyableCode code="tag_key" /></td><td><code>string</code></td><td>Tag key.</td></tr> | ||
| <tr><td><CopyableCode code="tag_value" /></td><td><code>string</code></td><td>Tag value.</td></tr> | ||
| <tr><td><CopyableCode code="region" /></td><td><code>string</code></td><td>AWS region.</td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Methods | ||
|
|
||
| <table><tbody> | ||
| <tr> | ||
| <th>Name</th> | ||
| <th>Accessible by</th> | ||
| <th>Required Params</th> | ||
| </tr> | ||
| <tr> | ||
| <td><CopyableCode code="list_resources" /></td> | ||
| <td><code>SELECT</code></td> | ||
| <td><CopyableCode code="region" /></td> | ||
| </tr> | ||
| </tbody></table> | ||
|
|
||
| ## `SELECT` examples | ||
| Expands tags for all <code>analyzers</code> in a region. | ||
| ```sql | ||
| SELECT | ||
| region, | ||
| analyzer_name, | ||
| archive_rules, | ||
| arn, | ||
| type, | ||
| analyzer_configuration, | ||
| tag_key, | ||
| tag_value | ||
| FROM aws.accessanalyzer.analyzer_tags | ||
| WHERE region = 'us-east-1'; | ||
| ``` | ||
|
|
||
|
|
||
| ## Permissions | ||
|
|
||
| For permissions required to operate on the <code>analyzer_tags</code> resource, see <a href="/providers/aws/accessanalyzer/analyzers/#permissions"><code>analyzers</code></a> | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
72 changes: 72 additions & 0 deletions
72
docs/aws-docs/providers/aws/accessanalyzer/analyzers_list_only/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| --- | ||
| title: analyzers_list_only | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - analyzers_list_only | ||
| - accessanalyzer | ||
| - 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 | ||
| --- | ||
|
|
||
| import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | ||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| Lists <code>analyzers</code> in a region or regions, for all properties use <a href="/providers/aws/serviceName/analyzers/"><code>analyzers</code></a> | ||
|
|
||
| ## Overview | ||
| <table><tbody> | ||
| <tr><td><b>Name</b></td><td><code>analyzers_list_only</code></td></tr> | ||
| <tr><td><b>Type</b></td><td>Resource</td></tr> | ||
| <tr><td><b>Description</b></td><td>The AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account</td></tr> | ||
| <tr><td><b>Id</b></td><td><CopyableCode code="aws.accessanalyzer.analyzers_list_only" /></td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Fields | ||
| <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> | ||
| <tr><td><CopyableCode code="archive_rules" /></td><td><code>array</code></td><td></td></tr> | ||
| <tr><td><CopyableCode code="arn" /></td><td><code>string</code></td><td>Amazon Resource Name (ARN) of the analyzer</td></tr> | ||
| <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> | ||
| <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> | ||
| <tr><td><CopyableCode code="analyzer_configuration" /></td><td><code>object</code></td><td>The configuration for the analyzer</td></tr> | ||
| <tr><td><CopyableCode code="region" /></td><td><code>string</code></td><td>AWS region.</td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Methods | ||
|
|
||
| <table><tbody> | ||
| <tr> | ||
| <th>Name</th> | ||
| <th>Accessible by</th> | ||
| <th>Required Params</th> | ||
| </tr> | ||
| <tr> | ||
| <td><CopyableCode code="list_resources" /></td> | ||
| <td><code>SELECT</code></td> | ||
| <td><CopyableCode code="region" /></td> | ||
| </tr> | ||
| </tbody></table> | ||
|
|
||
| ## `SELECT` examples | ||
| Lists all <code>analyzers</code> in a region. | ||
| ```sql | ||
| SELECT | ||
| region, | ||
| arn | ||
| FROM aws.accessanalyzer.analyzers_list_only | ||
| WHERE region = 'us-east-1'; | ||
| ``` | ||
|
|
||
|
|
||
| ## Permissions | ||
|
|
||
| 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> | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
77 changes: 77 additions & 0 deletions
77
docs/aws-docs/providers/aws/acmpca/certificate_authorities_list_only/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| --- | ||
| title: certificate_authorities_list_only | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - certificate_authorities_list_only | ||
| - acmpca | ||
| - 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 | ||
| --- | ||
|
|
||
| import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | ||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| 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> | ||
|
|
||
| ## Overview | ||
| <table><tbody> | ||
| <tr><td><b>Name</b></td><td><code>certificate_authorities_list_only</code></td></tr> | ||
| <tr><td><b>Type</b></td><td>Resource</td></tr> | ||
| <tr><td><b>Description</b></td><td>Private certificate authority.</td></tr> | ||
| <tr><td><b>Id</b></td><td><CopyableCode code="aws.acmpca.certificate_authorities_list_only" /></td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Fields | ||
| <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> | ||
| <tr><td><CopyableCode code="type" /></td><td><code>string</code></td><td>The type of the certificate authority.</td></tr> | ||
| <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> | ||
| <tr><td><CopyableCode code="signing_algorithm" /></td><td><code>string</code></td><td>Algorithm your CA uses to sign certificate requests.</td></tr> | ||
| <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> | ||
| <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> | ||
| <tr><td><CopyableCode code="tags" /></td><td><code>array</code></td><td></td></tr> | ||
| <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> | ||
| <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> | ||
| <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> | ||
| <tr><td><CopyableCode code="usage_mode" /></td><td><code>string</code></td><td>Usage mode of the ceritificate authority.</td></tr> | ||
| <tr><td><CopyableCode code="region" /></td><td><code>string</code></td><td>AWS region.</td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Methods | ||
|
|
||
| <table><tbody> | ||
| <tr> | ||
| <th>Name</th> | ||
| <th>Accessible by</th> | ||
| <th>Required Params</th> | ||
| </tr> | ||
| <tr> | ||
| <td><CopyableCode code="list_resources" /></td> | ||
| <td><code>SELECT</code></td> | ||
| <td><CopyableCode code="region" /></td> | ||
| </tr> | ||
| </tbody></table> | ||
|
|
||
| ## `SELECT` examples | ||
| Lists all <code>certificate_authorities</code> in a region. | ||
| ```sql | ||
| SELECT | ||
| region, | ||
| arn | ||
| FROM aws.acmpca.certificate_authorities_list_only | ||
| WHERE region = 'us-east-1'; | ||
| ``` | ||
|
|
||
|
|
||
| ## Permissions | ||
|
|
||
| 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> | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.