Merge pull request #163 from stackql/feature/doc-updates

aws doc updates

Author: jeffreyaven

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

@@ -49,7 +49,7 @@ Used to retrieve a list of <code>analyzers</code> in a region or to create or de
   <tr>
     <td><CopyableCode code="create_resource" /></td>
     <td><code>INSERT</code></td>
-    <td><CopyableCode code="data__DesiredState, region" /></td>
+    <td><CopyableCode code="Type, region" /></td>
   </tr>
   <tr>
     <td><CopyableCode code="delete_resource" /></td>
@@ -87,7 +87,7 @@ Use the following StackQL query and manifest file to create a new <code>analyzer
 <TabItem value="required">
 
 ```sql
--- analyzer.iql (required properties only)
+/*+ create */
 INSERT INTO aws.accessanalyzer.analyzers (
  Type,
  region
@@ -100,7 +100,7 @@ SELECT
 <TabItem value="all">
 
 ```sql
--- analyzer.iql (all properties)
+/*+ create */
 INSERT INTO aws.accessanalyzer.analyzers (
  AnalyzerName,
  ArchiveRules,
@@ -164,6 +164,7 @@ resources:
 ## `DELETE` Example
 
 ```sql
+/*+ delete */
 DELETE FROM aws.accessanalyzer.analyzers
 WHERE data__Identifier = '<Arn>'
 AND region = 'us-east-1';

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

@@ -26,20 +26,20 @@ Gets or updates an individual <code>certificate</code> resource, use <code>certi
 <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 &#91;IssueCertificate&#93;(https:&#x2F;&#x2F;docs.aws.amazon.com&#x2F;privateca&#x2F;latest&#x2F;APIReference&#x2F;API_IssueCertificate.html) action.</td></tr>
+<tr><td><b>Description</b></td><td>The <code>AWS::ACMPCA::Certificate</code> 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>
 <tr><td><b>Id</b></td><td><CopyableCode code="aws.acmpca.certificate" /></td></tr>
 </tbody></table>
 
 ## Fields
 <table><tbody>
 <tr><th>Name</th><th>Datatype</th><th>Description</th></tr>
-<tr><td><CopyableCode code="api_passthrough" /></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><CopyableCode code="api_passthrough" /></td><td><code>object</code></td><td>Specifies X.509 certificate information to be included in the issued certificate. An <code>APIPassthrough</code> or <code>APICSRPassthrough</code> template variant must be selected, or else this parameter is ignored.</td></tr>
 <tr><td><CopyableCode code="certificate_authority_arn" /></td><td><code>string</code></td><td>The Amazon Resource Name (ARN) for the private CA issues the certificate.</td></tr>
 <tr><td><CopyableCode code="certificate_signing_request" /></td><td><code>string</code></td><td>The certificate signing request (CSR) for the certificate.</td></tr>
-<tr><td><CopyableCode code="signing_algorithm" /></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>
-<tr><td><CopyableCode code="template_arn" /></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>
+<tr><td><CopyableCode code="signing_algorithm" /></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 <code>SigningAlgorithm</code> parameter used to sign a CSR in the <code>CreateCertificateAuthority</code> 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>
+<tr><td><CopyableCode code="template_arn" /></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 <code>EndEntityCertificate&#x2F;V1</code> 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>
 <tr><td><CopyableCode code="validity" /></td><td><code>object</code></td><td>The period of time during which the certificate will be valid.</td></tr>
-<tr><td><CopyableCode code="validity_not_before" /></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>
+<tr><td><CopyableCode code="validity_not_before" /></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 <code>ValidityNotBefore</code> parameter can be used to customize the “Not Before” value. &lt;br&#x2F;&gt; Unlike the <code>Validity</code> parameter, the <code>ValidityNotBefore</code> parameter is optional.&lt;br&#x2F;&gt; The <code>ValidityNotBefore</code> value is expressed as an explicit date and time, using the <code>Validity</code> type value <code>ABSOLUTE</code>.</td></tr>
 <tr><td><CopyableCode code="certificate" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="arn" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="region" /></td><td><code>string</code></td><td>AWS region.</td></tr>
@@ -54,11 +54,6 @@ Gets or updates an individual <code>certificate</code> resource, use <code>certi
     <th>Accessible by</th>
     <th>Required Params</th>
   </tr>
-  <tr>
-    <td><CopyableCode code="update_resource" /></td>
-    <td><code>UPDATE</code></td>
-    <td><CopyableCode code="data__Identifier, data__PatchDocument, region" /></td>
-  </tr>
   <tr>
     <td><CopyableCode code="get_resource" /></td>
     <td><code>SELECT</code></td>

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

@@ -49,7 +49,7 @@ Used to retrieve a list of <code>certificate_authorities</code> in a region or t
   <tr>
     <td><CopyableCode code="create_resource" /></td>
     <td><code>INSERT</code></td>
-    <td><CopyableCode code="data__DesiredState, region" /></td>
+    <td><CopyableCode code="Type, KeyAlgorithm, SigningAlgorithm, Subject, region" /></td>
   </tr>
   <tr>
     <td><CopyableCode code="delete_resource" /></td>
@@ -87,7 +87,7 @@ Use the following StackQL query and manifest file to create a new <code>certific
 <TabItem value="required">
 
 ```sql
--- certificate_authority.iql (required properties only)
+/*+ create */
 INSERT INTO aws.acmpca.certificate_authorities (
  Type,
  KeyAlgorithm,
@@ -106,7 +106,7 @@ SELECT
 <TabItem value="all">
 
 ```sql
--- certificate_authority.iql (all properties)
+/*+ create */
 INSERT INTO aws.acmpca.certificate_authorities (
  Type,
  KeyAlgorithm,
@@ -229,6 +229,7 @@ resources:
 ## `DELETE` Example
 
 ```sql
+/*+ delete */
 DELETE FROM aws.acmpca.certificate_authorities
 WHERE data__Identifier = '<Arn>'
 AND region = 'us-east-1';

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

@@ -49,7 +49,7 @@ Used to retrieve a list of <code>certificate_authority_activations</code> in a r
   <tr>
     <td><CopyableCode code="create_resource" /></td>
     <td><code>INSERT</code></td>
-    <td><CopyableCode code="data__DesiredState, region" /></td>
+    <td><CopyableCode code="CertificateAuthorityArn, Certificate, region" /></td>
   </tr>
   <tr>
     <td><CopyableCode code="delete_resource" /></td>
@@ -87,7 +87,7 @@ Use the following StackQL query and manifest file to create a new <code>certific
 <TabItem value="required">
 
 ```sql
--- certificate_authority_activation.iql (required properties only)
+/*+ create */
 INSERT INTO aws.acmpca.certificate_authority_activations (
  CertificateAuthorityArn,
  Certificate,
@@ -102,7 +102,7 @@ SELECT
 <TabItem value="all">
 
 ```sql
--- certificate_authority_activation.iql (all properties)
+/*+ create */
 INSERT INTO aws.acmpca.certificate_authority_activations (
  CertificateAuthorityArn,
  Certificate,
@@ -148,6 +148,7 @@ resources:
 ## `DELETE` Example
 
 ```sql
+/*+ delete */
 DELETE FROM aws.acmpca.certificate_authority_activations
 WHERE data__Identifier = '<CertificateAuthorityArn>'
 AND region = 'us-east-1';

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

@@ -26,7 +26,7 @@ Used to retrieve a list of <code>certificates</code> in a region or to create or
 <table><tbody>
 <tr><td><b>Name</b></td><td><code>certificates</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 &#91;IssueCertificate&#93;(https:&#x2F;&#x2F;docs.aws.amazon.com&#x2F;privateca&#x2F;latest&#x2F;APIReference&#x2F;API_IssueCertificate.html) action.</td></tr>
+<tr><td><b>Description</b></td><td>The <code>AWS::ACMPCA::Certificate</code> 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>
 <tr><td><b>Id</b></td><td><CopyableCode code="aws.acmpca.certificates" /></td></tr>
 </tbody></table>
 
@@ -50,7 +50,7 @@ Used to retrieve a list of <code>certificates</code> in a region or to create or
   <tr>
     <td><CopyableCode code="create_resource" /></td>
     <td><code>INSERT</code></td>
-    <td><CopyableCode code="data__DesiredState, region" /></td>
+    <td><CopyableCode code="CertificateAuthorityArn, CertificateSigningRequest, SigningAlgorithm, Validity, region" /></td>
   </tr>
   <tr>
     <td><CopyableCode code="delete_resource" /></td>
@@ -89,7 +89,7 @@ Use the following StackQL query and manifest file to create a new <code>certific
 <TabItem value="required">
 
 ```sql
--- certificate.iql (required properties only)
+/*+ create */
 INSERT INTO aws.acmpca.certificates (
  CertificateAuthorityArn,
  CertificateSigningRequest,
@@ -108,7 +108,7 @@ SELECT
 <TabItem value="all">
 
 ```sql
--- certificate.iql (all properties)
+/*+ create */
 INSERT INTO aws.acmpca.certificates (
  ApiPassthrough,
  CertificateAuthorityArn,
@@ -223,6 +223,7 @@ resources:
 ## `DELETE` Example
 
 ```sql
+/*+ delete */
 DELETE FROM aws.acmpca.certificates
 WHERE data__Identifier = '<Arn|CertificateAuthorityArn>'
 AND region = 'us-east-1';

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

@@ -50,7 +50,7 @@ Used to retrieve a list of <code>permissions</code> in a region or to create or
   <tr>
     <td><CopyableCode code="create_resource" /></td>
     <td><code>INSERT</code></td>
-    <td><CopyableCode code="data__DesiredState, region" /></td>
+    <td><CopyableCode code="Actions, CertificateAuthorityArn, Principal, region" /></td>
   </tr>
   <tr>
     <td><CopyableCode code="delete_resource" /></td>
@@ -89,7 +89,7 @@ Use the following StackQL query and manifest file to create a new <code>permissi
 <TabItem value="required">
 
 ```sql
--- permission.iql (required properties only)
+/*+ create */
 INSERT INTO aws.acmpca.permissions (
  Actions,
  CertificateAuthorityArn,
@@ -106,7 +106,7 @@ SELECT
 <TabItem value="all">
 
 ```sql
--- permission.iql (all properties)
+/*+ create */
 INSERT INTO aws.acmpca.permissions (
  Actions,
  CertificateAuthorityArn,
@@ -153,6 +153,7 @@ resources:
 ## `DELETE` Example
 
 ```sql
+/*+ delete */
 DELETE FROM aws.acmpca.permissions
 WHERE data__Identifier = '<CertificateAuthorityArn|Principal>'
 AND region = 'us-east-1';

docs/aws-docs/providers/aws/amplify/apps/index.md

@@ -49,7 +49,7 @@ Used to retrieve a list of <code>apps</code> in a region or to create or delete
   <tr>
     <td><CopyableCode code="create_resource" /></td>
     <td><code>INSERT</code></td>
-    <td><CopyableCode code="data__DesiredState, region" /></td>
+    <td><CopyableCode code="Name, region" /></td>
   </tr>
   <tr>
     <td><CopyableCode code="delete_resource" /></td>
@@ -87,7 +87,7 @@ Use the following StackQL query and manifest file to create a new <code>app</cod
 <TabItem value="required">
 
 ```sql
--- app.iql (required properties only)
+/*+ create */
 INSERT INTO aws.amplify.apps (
  Name,
  region
@@ -100,7 +100,7 @@ SELECT
 <TabItem value="all">
 
 ```sql
--- app.iql (all properties)
+/*+ create */
 INSERT INTO aws.amplify.apps (
  AccessToken,
  AutoBranchCreationConfig,
@@ -214,6 +214,7 @@ resources:
 ## `DELETE` Example
 
 ```sql
+/*+ delete */
 DELETE FROM aws.amplify.apps
 WHERE data__Identifier = '<Arn>'
 AND region = 'us-east-1';

docs/aws-docs/providers/aws/amplify/branches/index.md

@@ -49,7 +49,7 @@ Used to retrieve a list of <code>branches</code> in a region or to create or del
   <tr>
     <td><CopyableCode code="create_resource" /></td>
     <td><code>INSERT</code></td>
-    <td><CopyableCode code="data__DesiredState, region" /></td>
+    <td><CopyableCode code="AppId, BranchName, region" /></td>
   </tr>
   <tr>
     <td><CopyableCode code="delete_resource" /></td>
@@ -87,7 +87,7 @@ Use the following StackQL query and manifest file to create a new <code>branch</
 <TabItem value="required">
 
 ```sql
--- branch.iql (required properties only)
+/*+ create */
 INSERT INTO aws.amplify.branches (
  AppId,
  BranchName,
@@ -102,7 +102,7 @@ SELECT
 <TabItem value="all">
 
 ```sql
--- branch.iql (all properties)
+/*+ create */
 INSERT INTO aws.amplify.branches (
  AppId,
  BasicAuthConfig,
@@ -196,6 +196,7 @@ resources:
 ## `DELETE` Example
 
 ```sql
+/*+ delete */
 DELETE FROM aws.amplify.branches
 WHERE data__Identifier = '<Arn>'
 AND region = 'us-east-1';

docs/aws-docs/providers/aws/amplify/domains/index.md

@@ -49,7 +49,7 @@ Used to retrieve a list of <code>domains</code> in a region or to create or dele
   <tr>
     <td><CopyableCode code="create_resource" /></td>
     <td><code>INSERT</code></td>
-    <td><CopyableCode code="data__DesiredState, region" /></td>
+    <td><CopyableCode code="AppId, DomainName, SubDomainSettings, region" /></td>
   </tr>
   <tr>
     <td><CopyableCode code="delete_resource" /></td>
@@ -87,7 +87,7 @@ Use the following StackQL query and manifest file to create a new <code>domain</
 <TabItem value="required">
 
 ```sql
--- domain.iql (required properties only)
+/*+ create */
 INSERT INTO aws.amplify.domains (
  AppId,
  DomainName,
@@ -104,7 +104,7 @@ SELECT
 <TabItem value="all">
 
 ```sql
--- domain.iql (all properties)
+/*+ create */
 INSERT INTO aws.amplify.domains (
  AppId,
  AutoSubDomainCreationPatterns,
@@ -167,6 +167,7 @@ resources:
 ## `DELETE` Example
 
 ```sql
+/*+ delete */
 DELETE FROM aws.amplify.domains
 WHERE data__Identifier = '<Arn>'
 AND region = 'us-east-1';

docs/aws-docs/providers/aws/amplifyuibuilder/components/index.md

@@ -51,7 +51,7 @@ Used to retrieve a list of <code>components</code> in a region or to create or d
   <tr>
     <td><CopyableCode code="create_resource" /></td>
     <td><code>INSERT</code></td>
-    <td><CopyableCode code="data__DesiredState, region" /></td>
+    <td><CopyableCode code="region" /></td>
   </tr>
   <tr>
     <td><CopyableCode code="delete_resource" /></td>
@@ -91,7 +91,7 @@ Use the following StackQL query and manifest file to create a new <code>componen
 <TabItem value="required">
 
 ```sql
--- component.iql (required properties only)
+/*+ create */
 INSERT INTO aws.amplifyuibuilder.components (
  AppId,
  BindingProperties,
@@ -130,7 +130,7 @@ SELECT
 <TabItem value="all">
 
 ```sql
--- component.iql (all properties)
+/*+ create */
 INSERT INTO aws.amplifyuibuilder.components (
  AppId,
  BindingProperties,
@@ -225,6 +225,7 @@ resources:
 ## `DELETE` Example
 
 ```sql
+/*+ delete */
 DELETE FROM aws.amplifyuibuilder.components
 WHERE data__Identifier = '<AppId|EnvironmentName|Id>'
 AND region = 'us-east-1';

docs/aws-docs/providers/aws/amplifyuibuilder/forms/index.md

@@ -51,7 +51,7 @@ Used to retrieve a list of <code>forms</code> in a region or to create or delete
   <tr>
     <td><CopyableCode code="create_resource" /></td>
     <td><code>INSERT</code></td>
-    <td><CopyableCode code="data__DesiredState, region" /></td>
+    <td><CopyableCode code="region" /></td>
   </tr>
   <tr>
     <td><CopyableCode code="delete_resource" /></td>
@@ -91,7 +91,7 @@ Use the following StackQL query and manifest file to create a new <code>form</co
 <TabItem value="required">
 
 ```sql
--- form.iql (required properties only)
+/*+ create */
 INSERT INTO aws.amplifyuibuilder.forms (
  AppId,
  Cta,
@@ -126,7 +126,7 @@ SELECT
 <TabItem value="all">
 
 ```sql
--- form.iql (all properties)
+/*+ create */
 INSERT INTO aws.amplifyuibuilder.forms (
  AppId,
  Cta,
@@ -216,6 +216,7 @@ resources:
 ## `DELETE` Example
 
 ```sql
+/*+ delete */
 DELETE FROM aws.amplifyuibuilder.forms
 WHERE data__Identifier = '<AppId|EnvironmentName|Id>'
 AND region = 'us-east-1';