-
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 #138 from stackql/feature/doc-updates
Feature/doc updates
- Loading branch information
Showing
4,761 changed files
with
203,702 additions
and
157,650 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
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
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
Large diffs are not rendered by default.
Oops, something went wrong.
104 changes: 104 additions & 0 deletions
104
docs/aws-docs/providers/aws/accessanalyzer/analyzer/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,104 @@ | ||
| --- | ||
| title: analyzer | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - analyzer | ||
| - 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 | ||
| --- | ||
| Gets an individual <code>analyzer</code> resource | ||
|
|
||
| ## Overview | ||
| <table><tbody> | ||
| <tr><td><b>Name</b></td><td><code>analyzer</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><code>aws.accessanalyzer.analyzer</code></td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Fields | ||
| <table><tbody> | ||
| <tr><th>Name</th><th>Datatype</th><th>Description</th></tr> | ||
| <tr><td><code>analyzer_name</code></td><td><code>string</code></td><td>Analyzer name</td></tr> | ||
| <tr><td><code>archive_rules</code></td><td><code>array</code></td><td></td></tr> | ||
| <tr><td><code>arn</code></td><td><code>string</code></td><td>Amazon Resource Name (ARN) of the analyzer</td></tr> | ||
| <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> | ||
| <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> | ||
| <tr><td><code>analyzer_configuration</code></td><td><code>object</code></td><td>The configuration for the analyzer</td></tr> | ||
| <tr><td><code>region</code></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><code>update_resource</code></td> | ||
| <td><code>UPDATE</code></td> | ||
| <td><code>data__Identifier, data__PatchDocument, region</code></td> | ||
| </tr> | ||
| <tr> | ||
| <td><code>delete_resource</code></td> | ||
| <td><code>DELETE</code></td> | ||
| <td><code>data__Identifier, region</code></td> | ||
| </tr> | ||
| <tr> | ||
| <td><code>get_resource</code></td> | ||
| <td><code>SELECT</code></td> | ||
| <td><code>data__Identifier, region</code></td> | ||
| </tr> | ||
| </tbody></table> | ||
|
|
||
| ## `SELECT` Example | ||
| ```sql | ||
| SELECT | ||
| region, | ||
| analyzer_name, | ||
| archive_rules, | ||
| arn, | ||
| tags, | ||
| type, | ||
| analyzer_configuration | ||
| FROM aws.accessanalyzer.analyzer | ||
| WHERE data__Identifier = '<Arn>'; | ||
| ``` | ||
|
|
||
| ## Permissions | ||
|
|
||
| To operate on the <code>analyzer</code> resource, the following permissions are required: | ||
|
|
||
| ### Read | ||
| ```json | ||
| access-analyzer:ListAnalyzers, | ||
| access-analyzer:GetAnalyzer, | ||
| access-analyzer:ListArchiveRules | ||
| ``` | ||
|
|
||
| ### Update | ||
| ```json | ||
| access-analyzer:CreateArchiveRule, | ||
| access-analyzer:DeleteArchiveRule, | ||
| access-analyzer:ListAnalyzers, | ||
| access-analyzer:TagResource, | ||
| access-analyzer:UntagResource, | ||
| access-analyzer:UpdateArchiveRule | ||
| ``` | ||
|
|
||
| ### Delete | ||
| ```json | ||
| access-analyzer:DeleteAnalyzer | ||
| ``` | ||
|
|
81 changes: 81 additions & 0 deletions
81
docs/aws-docs/providers/aws/accessanalyzer/analyzers/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,81 @@ | ||
| --- | ||
| title: analyzers | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - analyzers | ||
| - 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 | ||
| --- | ||
| Retrieves a list of <code>analyzers</code> in a region | ||
|
|
||
| ## Overview | ||
| <table><tbody> | ||
| <tr><td><b>Name</b></td><td><code>analyzers</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><code>aws.accessanalyzer.analyzers</code></td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Fields | ||
| <table><tbody> | ||
| <tr><th>Name</th><th>Datatype</th><th>Description</th></tr> | ||
| <tr><td><code>arn</code></td><td><code>string</code></td><td>Amazon Resource Name (ARN) of the analyzer</td></tr> | ||
| <tr><td><code>region</code></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><code>create_resource</code></td> | ||
| <td><code>INSERT</code></td> | ||
| <td><code>data__DesiredState, region</code></td> | ||
| </tr> | ||
| <tr> | ||
| <td><code>list_resource</code></td> | ||
| <td><code>SELECT</code></td> | ||
| <td><code>region</code></td> | ||
| </tr> | ||
| </tbody></table> | ||
|
|
||
| ## `SELECT` Example | ||
| ```sql | ||
| SELECT | ||
| region, | ||
| arn | ||
| FROM aws.accessanalyzer.analyzers | ||
| WHERE region = 'us-east-1' | ||
| ``` | ||
|
|
||
| ## Permissions | ||
|
|
||
| To operate on the <code>analyzers</code> resource, the following permissions are required: | ||
|
|
||
| ### Create | ||
| ```json | ||
| access-analyzer:CreateAnalyzer, | ||
| access-analyzer:TagResource, | ||
| iam:CreateServiceLinkedRole, | ||
| organizations:ListAWSServiceAccessForOrganization, | ||
| organizations:ListDelegatedAdministrators | ||
| ``` | ||
|
|
||
| ### List | ||
| ```json | ||
| access-analyzer:ListAnalyzers | ||
| ``` | ||
|
|
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,39 @@ | ||
| --- | ||
| title: accessanalyzer | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - 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 | ||
| --- | ||
|
|
||
| The accessanalyzer service documentation. | ||
|
|
||
| :::info Service Summary | ||
|
|
||
| <div class="row"> | ||
| <div class="providerDocColumn"> | ||
| <span>total resources: <b>2</b></span><br /> | ||
| <span>total selectable resources: <b>2</b></span><br /> | ||
| <span>total methods: <b>2</b></span><br /> | ||
| </div> | ||
| </div> | ||
|
|
||
| ::: | ||
|
|
||
| ## Resources | ||
| <div class="row"> | ||
| <div class="providerDocColumn"> | ||
| <a href="/providers/aws/accessanalyzer/analyzer/">analyzer</a> | ||
| </div> | ||
| <div class="providerDocColumn"> | ||
| <a href="/providers/aws/accessanalyzer/analyzers/">analyzers</a> | ||
| </div> | ||
| </div> |
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,98 @@ | ||
| --- | ||
| title: certificate | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - certificate | ||
| - 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 | ||
| --- | ||
| Gets an individual <code>certificate</code> resource | ||
|
|
||
| ## Overview | ||
| <table><tbody> | ||
| <tr><td><b>Name</b></td><td><code>certificate</code></td></tr> | ||
| <tr><td><b>Type</b></td><td>Resource</td></tr> | ||
| <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 [IssueCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) action.</td></tr> | ||
| <tr><td><b>Id</b></td><td><code>aws.acmpca.certificate</code></td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Fields | ||
| <table><tbody> | ||
| <tr><th>Name</th><th>Datatype</th><th>Description</th></tr> | ||
| <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> | ||
| <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> | ||
| <tr><td><code>certificate_signing_request</code></td><td><code>string</code></td><td>The certificate signing request (CSR) for the certificate.</td></tr> | ||
| <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. <br/> This parameter should not be confused with the ``SigningAlgorithm`` parameter used to sign a CSR in the ``CreateCertificateAuthority`` action.<br/> The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.</td></tr> | ||
| <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/V1`` template. For more information about PCAshort templates, see [Using Templates](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html).</td></tr> | ||
| <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> | ||
| <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.<br/> 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. <br/> Unlike the ``Validity`` parameter, the ``ValidityNotBefore`` parameter is optional.<br/> The ``ValidityNotBefore`` value is expressed as an explicit date and time, using the ``Validity`` type value ``ABSOLUTE``.</td></tr> | ||
| <tr><td><code>certificate</code></td><td><code>string</code></td><td></td></tr> | ||
| <tr><td><code>arn</code></td><td><code>string</code></td><td></td></tr> | ||
| <tr><td><code>region</code></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><code>update_resource</code></td> | ||
| <td><code>UPDATE</code></td> | ||
| <td><code>data__Identifier, data__PatchDocument, region</code></td> | ||
| </tr> | ||
| <tr> | ||
| <td><code>delete_resource</code></td> | ||
| <td><code>DELETE</code></td> | ||
| <td><code>data__Identifier, region</code></td> | ||
| </tr> | ||
| <tr> | ||
| <td><code>get_resource</code></td> | ||
| <td><code>SELECT</code></td> | ||
| <td><code>data__Identifier, region</code></td> | ||
| </tr> | ||
| </tbody></table> | ||
|
|
||
| ## `SELECT` Example | ||
| ```sql | ||
| SELECT | ||
| region, | ||
| api_passthrough, | ||
| certificate_authority_arn, | ||
| certificate_signing_request, | ||
| signing_algorithm, | ||
| template_arn, | ||
| validity, | ||
| validity_not_before, | ||
| certificate, | ||
| arn | ||
| FROM aws.acmpca.certificate | ||
| WHERE data__Identifier = '<Arn>|<CertificateAuthorityArn>'; | ||
| ``` | ||
|
|
||
| ## Permissions | ||
|
|
||
| To operate on the <code>certificate</code> resource, the following permissions are required: | ||
|
|
||
| ### Read | ||
| ```json | ||
| acm-pca:GetCertificate | ||
| ``` | ||
|
|
||
| ### Delete | ||
| ```json | ||
| acm-pca:GetCertificate | ||
| ``` | ||
|
|
Oops, something went wrong.