Skip to content

Commit

Permalink
Merge pull request #155 from stackql/feature/doc-updates
Browse files Browse the repository at this point in the history 
updated aws docs
  • Loading branch information
@jeffreyaven
jeffreyaven authored May 10, 2024
2 parents c727392 + 7b08305 commit 5cb05a1
Show file tree
Hide file tree
Showing 1,916 changed files with 132,317 additions and 15,127 deletions.
2 changes: 1 addition & 1 deletion docs/aws-docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';

Cloud services from AWS.

:::info Provider Summary (v24.05.00228)
:::info Provider Summary (v24.05.00230)

<div class="row">
<div class="providerDocColumn">
Expand Down
18 changes: 6 additions & 12 deletions docs/aws-docs/providers/aws/accessanalyzer/analyzer/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@ 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';

Gets or operates on an individual <code>analyzer</code> resource, use <code>analyzers</code> to retrieve a list of resources or to create a resource.

Gets or updates an individual <code>analyzer</code> resource, use <code>analyzers</code> to retrieve a list of resources or to create or delete a resource.

## Overview
<table><tbody>
Expand Down Expand Up @@ -53,11 +56,6 @@ Gets or operates on an individual <code>analyzer</code> resource, use <code>anal
<td><code>UPDATE</code></td>
<td><CopyableCode code="data__Identifier, data__PatchDocument, region" /></td>
</tr>
<tr>
<td><CopyableCode code="delete_resource" /></td>
<td><code>DELETE</code></td>
<td><CopyableCode code="data__Identifier, region" /></td>
</tr>
<tr>
<td><CopyableCode code="get_resource" /></td>
<td><code>SELECT</code></td>
Expand All @@ -76,9 +74,10 @@ tags,
type,
analyzer_configuration
FROM aws.accessanalyzer.analyzer
WHERE data__Identifier = '<Arn>';
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';
```


## Permissions

To operate on the <code>analyzer</code> resource, the following permissions are required:
Expand All @@ -100,8 +99,3 @@ access-analyzer:UntagResource,
access-analyzer:UpdateArchiveRule
```

### Delete
```json
access-analyzer:DeleteAnalyzer
```

115 changes: 113 additions & 2 deletions docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@ 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';

Used to retrieve a list of <code>analyzers</code> in a region or create a <code>analyzers</code> resource, use <code>analyzer</code> to operate on an individual resource.

Used to retrieve a list of <code>analyzers</code> in a region or to create or delete a <code>analyzers</code> resource, use <code>analyzer</code> to read or update an individual resource.

## Overview
<table><tbody>
Expand Down Expand Up @@ -48,6 +51,11 @@ Used to retrieve a list of <code>analyzers</code> in a region or create a <code>
<td><code>INSERT</code></td>
<td><CopyableCode code="data__DesiredState, region" /></td>
</tr>
<tr>
<td><CopyableCode code="delete_resource" /></td>
<td><code>DELETE</code></td>
<td><CopyableCode code="data__Identifier, region" /></td>
</tr>
<tr>
<td><CopyableCode code="list_resource" /></td>
<td><code>SELECT</code></td>
Expand All @@ -61,7 +69,105 @@ SELECT
region,
arn
FROM aws.accessanalyzer.analyzers
WHERE region = 'us-east-1'
WHERE region = 'us-east-1';
```

## `INSERT` Example

<Tabs
defaultValue="required"
values={[
{ label: 'Required Properties', value: 'required', },
{ label: 'All Properties', value: 'all', },

]
}>
<TabItem value="required">

```sql
<<<json
{
"Type": "{{ Type }}"
}
>>>
--required properties only
INSERT INTO aws.accessanalyzer.analyzers (
Type,
region
)
SELECT
{{ Type }},
'us-east-1';
```

</TabItem>
<TabItem value="all">

```sql
<<<json
{
"AnalyzerName": "{{ AnalyzerName }}",
"ArchiveRules": [
{
"Filter": [
{
"Contains": [
"{{ Contains[0] }}"
],
"Eq": [
"{{ Eq[0] }}"
],
"Exists": "{{ Exists }}",
"Property": "{{ Property }}",
"Neq": [
"{{ Neq[0] }}"
]
}
],
"RuleName": "{{ RuleName }}"
}
],
"Tags": [
{
"Key": "{{ Key }}",
"Value": "{{ Value }}"
}
],
"Type": "{{ Type }}",
"AnalyzerConfiguration": {
"UnusedAccessConfiguration": {
"UnusedAccessAge": "{{ UnusedAccessAge }}"
}
}
}
>>>
--all properties
INSERT INTO aws.accessanalyzer.analyzers (
AnalyzerName,
ArchiveRules,
Tags,
Type,
AnalyzerConfiguration,
region
)
SELECT
{{ AnalyzerName }},
{{ ArchiveRules }},
{{ Tags }},
{{ Type }},
{{ AnalyzerConfiguration }},
'us-east-1';
```

</TabItem>
</Tabs>

## `DELETE` Example

```sql
DELETE FROM aws.accessanalyzer.analyzers
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';
```

## Permissions
Expand All @@ -77,6 +183,11 @@ organizations:ListAWSServiceAccessForOrganization,
organizations:ListDelegatedAdministrators
```

### Delete
```json
access-analyzer:DeleteAnalyzer
```

### List
```json
access-analyzer:ListAnalyzers
Expand Down
18 changes: 6 additions & 12 deletions docs/aws-docs/providers/aws/acmpca/certificate/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@ 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';

Gets or operates on an individual <code>certificate</code> resource, use <code>certificates</code> to retrieve a list of resources or to create a resource.

Gets or updates an individual <code>certificate</code> resource, use <code>certificates</code> to retrieve a list of resources or to create or delete a resource.

## Overview
<table><tbody>
Expand Down Expand Up @@ -56,11 +59,6 @@ Gets or operates on an individual <code>certificate</code> resource, use <code>c
<td><code>UPDATE</code></td>
<td><CopyableCode code="data__Identifier, data__PatchDocument, region" /></td>
</tr>
<tr>
<td><CopyableCode code="delete_resource" /></td>
<td><code>DELETE</code></td>
<td><CopyableCode code="data__Identifier, region" /></td>
</tr>
<tr>
<td><CopyableCode code="get_resource" /></td>
<td><code>SELECT</code></td>
Expand All @@ -82,9 +80,10 @@ validity_not_before,
certificate,
arn
FROM aws.acmpca.certificate
WHERE data__Identifier = '<Arn>|<CertificateAuthorityArn>';
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>|<CertificateAuthorityArn>';
```


## Permissions

To operate on the <code>certificate</code> resource, the following permissions are required:
Expand All @@ -94,8 +93,3 @@ To operate on the <code>certificate</code> resource, the following permissions a
acm-pca:GetCertificate
```

### Delete
```json
acm-pca:GetCertificate
```

Loading

0 comments on commit 5cb05a1

Please sign in to comment.