Skip to content

Commit 94aefc5

Browse files
jeffreyavenjeffreyaven
authored
Merge pull request #164 from stackql/feature/doc-updates
aws doc updates
2 parents 96f94ba + 468fe01 commit 94aefc5

File tree

370 files changed

+5260
-3493
lines changed

Some content is hidden

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

370 files changed

+5260
-3493
lines changed

‎docs/aws-docs/index.md

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

2323
Cloud services from AWS.
2424

25-
:::info Provider Summary (v24.05.00230)
25+
:::info Provider Summary (v24.05.00232)
2626

2727
<div class="row">
2828
<div class="providerDocColumn">
29-
<span>total services:&nbsp;<b>220</b></span><br />
30-
<span>total methods:&nbsp;<b>7,597</b></span><br />
29+
<span>total services:&nbsp;<b>221</b></span><br />
30+
<span>total methods:&nbsp;<b>7,620</b></span><br />
3131
</div>
3232
<div class="providerDocColumn">
33-
<span>total resources:&nbsp;<b>2,269</b></span><br />
34-
<span>total selectable resources:&nbsp;<b>2,161</b></span><br />
33+
<span>total resources:&nbsp;<b>2,277</b></span><br />
34+
<span>total selectable resources:&nbsp;<b>2,170</b></span><br />
3535
</div>
3636
</div>
3737

@@ -205,9 +205,9 @@ This parameter must be supplied to the `WHERE` clause of each `SELECT` statement
205205
<a href="/providers/aws/iotanalytics/">iotanalytics</a><br />
206206
<a href="/providers/aws/iotcoredeviceadvisor/">iotcoredeviceadvisor</a><br />
207207
<a href="/providers/aws/iotevents/">iotevents</a><br />
208+
<a href="/providers/aws/iotfleethub/">iotfleethub</a><br />
208209
</div>
209210
<div class="providerDocColumn">
210-
<a href="/providers/aws/iotfleethub/">iotfleethub</a><br />
211211
<a href="/providers/aws/iotfleetwise/">iotfleetwise</a><br />
212212
<a href="/providers/aws/iotsitewise/">iotsitewise</a><br />
213213
<a href="/providers/aws/iottwinmaker/">iottwinmaker</a><br />
@@ -275,6 +275,7 @@ This parameter must be supplied to the `WHERE` clause of each `SELECT` statement
275275
<a href="/providers/aws/robomaker/">robomaker</a><br />
276276
<a href="/providers/aws/rolesanywhere/">rolesanywhere</a><br />
277277
<a href="/providers/aws/route53/">route53</a><br />
278+
<a href="/providers/aws/route53_api/">route53_api</a><br />
278279
<a href="/providers/aws/route53recoverycontrol/">route53recoverycontrol</a><br />
279280
<a href="/providers/aws/route53recoveryreadiness/">route53recoveryreadiness</a><br />
280281
<a href="/providers/aws/route53resolver/">route53resolver</a><br />

‎docs/aws-docs/providers/aws/cloudhsm/backups/index.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,35 +14,38 @@ description: Query, deploy and manage AWS resources using SQL
1414
custom_edit_url: null
1515
image: /img/providers/aws/stackql-aws-provider-featured-image.png
1616
---
17-
18-
17+
18+
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
19+
20+
21+
1922

2023
## Overview
2124
<table><tbody>
2225
<tr><td><b>Name</b></td><td><code>backups</code></td></tr>
2326
<tr><td><b>Type</b></td><td>Resource</td></tr>
24-
<tr><td><b>Id</b></td><td><code>aws.cloudhsm.backups</code></td></tr>
27+
<tr><td><b>Id</b></td><td><CopyableCode code="aws.cloudhsm.backups" /></td></tr>
2528
</tbody></table>
2629

2730
## Fields
2831
| Name | Datatype | Description |
2932
|:-----|:---------|:------------|
30-
| `BackupId` | `string` | The identifier (ID) of the backup. |
31-
| `BackupState` | `string` | The state of the backup. |
32-
| `ClusterId` | `string` | The identifier (ID) of the cluster that was backed up. |
33-
| `CopyTimestamp` | `string` | The date and time when the backup was copied from a source backup. |
34-
| `CreateTimestamp` | `string` | The date and time when the backup was created. |
35-
| `DeleteTimestamp` | `string` | The date and time when the backup will be permanently deleted. |
36-
| `NeverExpires` | `boolean` | Specifies whether the service should exempt a backup from the retention policy for the cluster. &lt;code&gt;True&lt;/code&gt; exempts a backup from the retention policy. &lt;code&gt;False&lt;/code&gt; means the service applies the backup retention policy defined at the cluster. |
37-
| `SourceBackup` | `string` | The identifier (ID) of the source backup from which the new backup was copied. |
38-
| `SourceCluster` | `string` | The identifier (ID) of the cluster containing the source backup from which the new backup was copied. |
39-
| `SourceRegion` | `string` | The AWS Region that contains the source backup from which the new backup was copied. |
40-
| `TagList` | `array` | The list of tags for the backup. |
33+
| <CopyableCode code="BackupId" /> | `string` | The identifier (ID) of the backup. |
34+
| <CopyableCode code="BackupState" /> | `string` | The state of the backup. |
35+
| <CopyableCode code="ClusterId" /> | `string` | The identifier (ID) of the cluster that was backed up. |
36+
| <CopyableCode code="CopyTimestamp" /> | `string` | The date and time when the backup was copied from a source backup. |
37+
| <CopyableCode code="CreateTimestamp" /> | `string` | The date and time when the backup was created. |
38+
| <CopyableCode code="DeleteTimestamp" /> | `string` | The date and time when the backup will be permanently deleted. |
39+
| <CopyableCode code="NeverExpires" /> | `boolean` | Specifies whether the service should exempt a backup from the retention policy for the cluster. &lt;code&gt;True&lt;/code&gt; exempts a backup from the retention policy. &lt;code&gt;False&lt;/code&gt; means the service applies the backup retention policy defined at the cluster. |
40+
| <CopyableCode code="SourceBackup" /> | `string` | The identifier (ID) of the source backup from which the new backup was copied. |
41+
| <CopyableCode code="SourceCluster" /> | `string` | The identifier (ID) of the cluster containing the source backup from which the new backup was copied. |
42+
| <CopyableCode code="SourceRegion" /> | `string` | The AWS Region that contains the source backup from which the new backup was copied. |
43+
| <CopyableCode code="TagList" /> | `array` | The list of tags for the backup. |
4144
## Methods
4245
| Name | Accessible by | Required Params | Description |
4346
|:-----|:--------------|:----------------|:------------|
44-
| `describe_backups` | `SELECT` | `region` | &lt;p&gt;Gets information about backups of AWS CloudHSM clusters.&lt;/p&gt; &lt;p&gt;This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a &lt;code&gt;NextToken&lt;/code&gt; value. Use this value in a subsequent &lt;code&gt;DescribeBackups&lt;/code&gt; request to get more backups. When you receive a response with no &lt;code&gt;NextToken&lt;/code&gt; (or an empty or null value), that means there are no more backups to get.&lt;/p&gt; |
45-
| `delete_backup` | `DELETE` | `X-Amz-Target, data__BackupId, region` | Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see &lt;a&gt;RestoreBackup&lt;/a&gt;. |
46-
| `copy_backup_to_region` | `EXEC` | `X-Amz-Target, data__BackupId, data__DestinationRegion, region` | Copy an AWS CloudHSM cluster backup to a different region. |
47-
| `modify_backup_attributes` | `EXEC` | `X-Amz-Target, data__BackupId, data__NeverExpires, region` | Modifies attributes for AWS CloudHSM backup. |
48-
| `restore_backup` | `EXEC` | `X-Amz-Target, data__BackupId, region` | Restores a specified AWS CloudHSM backup that is in the &lt;code&gt;PENDING_DELETION&lt;/code&gt; state. For mor information on deleting a backup, see &lt;a&gt;DeleteBackup&lt;/a&gt;. |
47+
| <CopyableCode code="describe_backups" /> | `SELECT` | <CopyableCode code="region" /> | &lt;p&gt;Gets information about backups of AWS CloudHSM clusters.&lt;/p&gt; &lt;p&gt;This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a &lt;code&gt;NextToken&lt;/code&gt; value. Use this value in a subsequent &lt;code&gt;DescribeBackups&lt;/code&gt; request to get more backups. When you receive a response with no &lt;code&gt;NextToken&lt;/code&gt; (or an empty or null value), that means there are no more backups to get.&lt;/p&gt; |
48+
| <CopyableCode code="delete_backup" /> | `DELETE` | <CopyableCode code="X-Amz-Target, data__BackupId, region" /> | Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see &lt;a&gt;RestoreBackup&lt;/a&gt;. |
49+
| <CopyableCode code="copy_backup_to_region" /> | `EXEC` | <CopyableCode code="X-Amz-Target, data__BackupId, data__DestinationRegion, region" /> | Copy an AWS CloudHSM cluster backup to a different region. |
50+
| <CopyableCode code="modify_backup_attributes" /> | `EXEC` | <CopyableCode code="X-Amz-Target, data__BackupId, data__NeverExpires, region" /> | Modifies attributes for AWS CloudHSM backup. |
51+
| <CopyableCode code="restore_backup" /> | `EXEC` | <CopyableCode code="X-Amz-Target, data__BackupId, region" /> | Restores a specified AWS CloudHSM backup that is in the &lt;code&gt;PENDING_DELETION&lt;/code&gt; state. For mor information on deleting a backup, see &lt;a&gt;DeleteBackup&lt;/a&gt;. |

‎docs/aws-docs/providers/aws/cloudhsm/clusters/index.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,39 +14,42 @@ description: Query, deploy and manage AWS resources using SQL
1414
custom_edit_url: null
1515
image: /img/providers/aws/stackql-aws-provider-featured-image.png
1616
---
17-
18-
17+
18+
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
19+
20+
21+
1922

2023
## Overview
2124
<table><tbody>
2225
<tr><td><b>Name</b></td><td><code>clusters</code></td></tr>
2326
<tr><td><b>Type</b></td><td>Resource</td></tr>
24-
<tr><td><b>Id</b></td><td><code>aws.cloudhsm.clusters</code></td></tr>
27+
<tr><td><b>Id</b></td><td><CopyableCode code="aws.cloudhsm.clusters" /></td></tr>
2528
</tbody></table>
2629

2730
## Fields
2831
| Name | Datatype | Description |
2932
|:-----|:---------|:------------|
30-
| `BackupPolicy` | `string` | The cluster's backup policy. |
31-
| `BackupRetentionPolicy` | `object` | A policy that defines the number of days to retain backups. |
32-
| `Certificates` | `object` | Contains one or more certificates or a certificate signing request (CSR). |
33-
| `ClusterId` | `string` | The cluster's identifier (ID). |
34-
| `CreateTimestamp` | `string` | The date and time when the cluster was created. |
35-
| `HsmType` | `string` | The type of HSM that the cluster contains. |
36-
| `Hsms` | `array` | Contains information about the HSMs in the cluster. |
37-
| `PreCoPassword` | `string` | The default password for the cluster's Pre-Crypto Officer (PRECO) user. |
38-
| `SecurityGroup` | `string` | The identifier (ID) of the cluster's security group. |
39-
| `SourceBackupId` | `string` | The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup. |
40-
| `State` | `string` | The cluster's state. |
41-
| `StateMessage` | `string` | A description of the cluster's state. |
42-
| `SubnetMapping` | `object` | A map from availability zone to the cluster’s subnet in that availability zone. |
43-
| `TagList` | `array` | The list of tags for the cluster. |
44-
| `VpcId` | `string` | The identifier (ID) of the virtual private cloud (VPC) that contains the cluster. |
33+
| <CopyableCode code="BackupPolicy" /> | `string` | The cluster's backup policy. |
34+
| <CopyableCode code="BackupRetentionPolicy" /> | `object` | A policy that defines the number of days to retain backups. |
35+
| <CopyableCode code="Certificates" /> | `object` | Contains one or more certificates or a certificate signing request (CSR). |
36+
| <CopyableCode code="ClusterId" /> | `string` | The cluster's identifier (ID). |
37+
| <CopyableCode code="CreateTimestamp" /> | `string` | The date and time when the cluster was created. |
38+
| <CopyableCode code="HsmType" /> | `string` | The type of HSM that the cluster contains. |
39+
| <CopyableCode code="Hsms" /> | `array` | Contains information about the HSMs in the cluster. |
40+
| <CopyableCode code="PreCoPassword" /> | `string` | The default password for the cluster's Pre-Crypto Officer (PRECO) user. |
41+
| <CopyableCode code="SecurityGroup" /> | `string` | The identifier (ID) of the cluster's security group. |
42+
| <CopyableCode code="SourceBackupId" /> | `string` | The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup. |
43+
| <CopyableCode code="State" /> | `string` | The cluster's state. |
44+
| <CopyableCode code="StateMessage" /> | `string` | A description of the cluster's state. |
45+
| <CopyableCode code="SubnetMapping" /> | `object` | A map from availability zone to the cluster’s subnet in that availability zone. |
46+
| <CopyableCode code="TagList" /> | `array` | The list of tags for the cluster. |
47+
| <CopyableCode code="VpcId" /> | `string` | The identifier (ID) of the virtual private cloud (VPC) that contains the cluster. |
4548
## Methods
4649
| Name | Accessible by | Required Params | Description |
4750
|:-----|:--------------|:----------------|:------------|
48-
| `describe_clusters` | `SELECT` | `region` | &lt;p&gt;Gets information about AWS CloudHSM clusters.&lt;/p&gt; &lt;p&gt;This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a &lt;code&gt;NextToken&lt;/code&gt; value. Use this value in a subsequent &lt;code&gt;DescribeClusters&lt;/code&gt; request to get more clusters. When you receive a response with no &lt;code&gt;NextToken&lt;/code&gt; (or an empty or null value), that means there are no more clusters to get.&lt;/p&gt; |
49-
| `create_cluster` | `INSERT` | `X-Amz-Target, data__HsmType, data__SubnetIds, region` | Creates a new AWS CloudHSM cluster. |
50-
| `delete_cluster` | `DELETE` | `X-Amz-Target, data__ClusterId, region` | Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use &lt;a&gt;DescribeClusters&lt;/a&gt;. To delete an HSM, use &lt;a&gt;DeleteHsm&lt;/a&gt;. |
51-
| `initialize_cluster` | `EXEC` | `X-Amz-Target, data__ClusterId, data__SignedCert, data__TrustAnchor, region` | Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use &lt;a&gt;DescribeClusters&lt;/a&gt;. |
52-
| `modify_cluster` | `EXEC` | `X-Amz-Target, data__BackupRetentionPolicy, data__ClusterId, region` | Modifies AWS CloudHSM cluster. |
51+
| <CopyableCode code="describe_clusters" /> | `SELECT` | <CopyableCode code="region" /> | &lt;p&gt;Gets information about AWS CloudHSM clusters.&lt;/p&gt; &lt;p&gt;This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a &lt;code&gt;NextToken&lt;/code&gt; value. Use this value in a subsequent &lt;code&gt;DescribeClusters&lt;/code&gt; request to get more clusters. When you receive a response with no &lt;code&gt;NextToken&lt;/code&gt; (or an empty or null value), that means there are no more clusters to get.&lt;/p&gt; |
52+
| <CopyableCode code="create_cluster" /> | `INSERT` | <CopyableCode code="X-Amz-Target, data__HsmType, data__SubnetIds, region" /> | Creates a new AWS CloudHSM cluster. |
53+
| <CopyableCode code="delete_cluster" /> | `DELETE` | <CopyableCode code="X-Amz-Target, data__ClusterId, region" /> | Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use &lt;a&gt;DescribeClusters&lt;/a&gt;. To delete an HSM, use &lt;a&gt;DeleteHsm&lt;/a&gt;. |
54+
| <CopyableCode code="initialize_cluster" /> | `EXEC` | <CopyableCode code="X-Amz-Target, data__ClusterId, data__SignedCert, data__TrustAnchor, region" /> | Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use &lt;a&gt;DescribeClusters&lt;/a&gt;. |
55+
| <CopyableCode code="modify_cluster" /> | `EXEC` | <CopyableCode code="X-Amz-Target, data__BackupRetentionPolicy, data__ClusterId, region" /> | Modifies AWS CloudHSM cluster. |

‎docs/aws-docs/providers/aws/cloudhsm/hsm/index.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,23 @@ description: Query, deploy and manage AWS resources using SQL
1414
custom_edit_url: null
1515
image: /img/providers/aws/stackql-aws-provider-featured-image.png
1616
---
17-
18-
17+
18+
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
19+
20+
21+
1922

2023
## Overview
2124
<table><tbody>
2225
<tr><td><b>Name</b></td><td><code>hsm</code></td></tr>
2326
<tr><td><b>Type</b></td><td>Resource</td></tr>
24-
<tr><td><b>Id</b></td><td><code>aws.cloudhsm.hsm</code></td></tr>
27+
<tr><td><b>Id</b></td><td><CopyableCode code="aws.cloudhsm.hsm" /></td></tr>
2528
</tbody></table>
2629

2730
## Fields
2831
`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
2932
## Methods
3033
| Name | Accessible by | Required Params | Description |
3134
|:-----|:--------------|:----------------|:------------|
32-
| `create_hsm` | `INSERT` | `X-Amz-Target, data__AvailabilityZone, data__ClusterId, region` | Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster. |
33-
| `delete_hsm` | `DELETE` | `X-Amz-Target, data__ClusterId, region` | Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use &lt;a&gt;DescribeClusters&lt;/a&gt;. |
35+
| <CopyableCode code="create_hsm" /> | `INSERT` | <CopyableCode code="X-Amz-Target, data__AvailabilityZone, data__ClusterId, region" /> | Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster. |
36+
| <CopyableCode code="delete_hsm" /> | `DELETE` | <CopyableCode code="X-Amz-Target, data__ClusterId, region" /> | Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use &lt;a&gt;DescribeClusters&lt;/a&gt;. |

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ description: Query, deploy and manage AWS resources using SQL
1313
custom_edit_url: null
1414
image: /img/providers/aws/stackql-aws-provider-featured-image.png
1515
---
16+
1617
cloudhsm
1718

1819
:::info Service Summary
@@ -33,7 +34,7 @@ cloudhsm
3334
<tr><td><b>Type</b></td><td>Service</td></tr>
3435
<tr><td><b>Title</b></td><td>cloudhsm</td></tr>
3536
<tr><td><b>Description</b></td><td>cloudhsm</td></tr>
36-
<tr><td><b>Id</b></td><td><code>cloudhsm:v00.00.00000</code></td></tr>
37+
<tr><td><b>Id</b></td><td><code>cloudhsm:v24.05.00232</code></td></tr>
3738
</tbody></table>
3839

3940
## Resources

0 commit comments

Comments
 (0)