Skip to content

Commit

Permalink
Document the new AWS resources (#299)
Browse files Browse the repository at this point in the history 
Signed-off-by: Tim Smith <[email protected]>
  • Loading branch information
@tas50
tas50 authored Aug 9, 2024
1 parent b9eeb91 commit 4677b1f
Show file tree
Hide file tree
Showing 10 changed files with 124 additions and 52 deletions.
6 changes: 4 additions & 2 deletions docs/mql/resources/aws-pack/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ Resources included in this pack:
| ID | DESCRIPTION |
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| [aws](aws.md) | AWS resource |
| [aws.accessAnalyzer](aws.accessanalyzer.md) | AWS IAM Access Analyzer resource (for assessing the configuration of AWS IAM Access Analyzer) |
| [aws.accessanalyzer.analyzer](aws.accessanalyzer.analyzer.md) | AWS IAM Access Analyzer resource (provides an object representing an individual AWS IAM Access Analyzer configuration) |
| [aws.account](aws.account.md) | AWS Account |
| [aws.acm](aws.acm.md) | AWS Certificate Manager resource (for assessing the configuration of AWS Certificate Manager) |
| [aws.acm.certificate](aws.acm.certificate.md) | AWS Certificate Manager Certificate resource (provides an object representing an individual ACM certificate) |
Expand Down Expand Up @@ -99,7 +97,11 @@ Resources included in this pack:
| [aws.es.domain](aws.es.domain.md) | Amazon Elasticsearch service domain |
| [aws.guardduty](aws.guardduty.md) | Amazon GuardDuty for threat detection |
| [aws.guardduty.detector](aws.guardduty.detector.md) | Amazon GuardDuty detector |
| [aws.guardduty.finding](aws.guardduty.finding.md) | AWS Guard Duty finding |
| [aws.iam](aws.iam.md) | AWS service to create and manage permissions for users and groups |
| [aws.iam.accessAnalyzer](aws.iam.accessanalyzer.md) | AWS IAM Access Analyzer resource (for assessing the configuration of AWS IAM Access Analyzer) |
| [aws.iam.accessanalyzer.analyzer](aws.iam.accessanalyzer.analyzer.md) | AWS IAM Access Analyzer resource (provides an object representing an individual AWS IAM Access Analyzer configuration) |
| [aws.iam.accessanalyzer.finding](aws.iam.accessanalyzer.finding.md) | AWS IAM Access Analyzer finding |
| [aws.iam.group](aws.iam.group.md) | AWS IAM group |
| [aws.iam.loginProfile](aws.iam.loginprofile.md) | AWS IAM login profile for a user |
| [aws.iam.policy](aws.iam.policy.md) | AWS IAM policy |
Expand Down
17 changes: 10 additions & 7 deletions docs/mql/resources/aws-pack/aws.guardduty.detector.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,13 @@ The `aws.guardduty.detector` resource provides fields for assessing the configur

**Fields**

| ID | TYPE | DESCRIPTION |
| -------------------------- | -------------- | ------------------------------------------------ |
| id | string | Unique ID for the detector |
| region | string | Region for the detector |
| status | string | Status of the detector: ENABLED or DISABLED |
| findingPublishingFrequency | string | Publishing frequency for the detector |
| unarchivedFindings | &#91;&#93;dict | List of unarchivedFindings found by the detector |
| ID | TYPE | DESCRIPTION |
| -------------------------- | ----------------------------------------------------------- | ------------------------------------------- |
| id | string | Unique ID for the detector |
| region | string | Region for the detector |
| status | string | Status of the detector: ENABLED or DISABLED |
| features | &#91;&#93;dict | Feature set for the detector |
| tags | map[string]string | Tags for the project |
| findingPublishingFrequency | string | Publishing frequency for the detector |
| findings | &#91;&#93;[aws.guardduty.finding](aws.guardduty.finding.md) | List of active findings by the detector |
| unarchivedFindings | &#91;&#93;dict | Deprecated (use `findings` instead) |
32 changes: 32 additions & 0 deletions docs/mql/resources/aws-pack/aws.guardduty.finding.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: aws.guardduty.finding
id: aws.guardduty.finding
sidebar_label: aws.guardduty.finding
displayed_sidebar: MQL
description: AWS Guard Duty finding
---

# aws.guardduty.finding

**Supported platform**

- aws

**Description**

AWS Guard Duty finding

**Fields**

| ID | TYPE | DESCRIPTION |
| ----------- | ------ | ---------------------------------- |
| arn | string | Unique ID for the finding |
| id | string | ID of the finding |
| region | string | Region where the finding was found |
| title | string | Title |
| description | string | Description |
| severity | float | Severity of the finding |
| confidence | float | Confidence level of the finding |
| type | string | Type of finding |
| createdAt | time | Created at time |
| updatedAt | time | Updated at time |
7 changes: 4 additions & 3 deletions docs/mql/resources/aws-pack/aws.guardduty.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@ Use the `aws.guardduty` resource to assess the configuration of the AWS GuardDut

**Fields**

| ID | TYPE | DESCRIPTION |
| --------- | ------------------------------------------------------------- | --------------------------- |
| detectors | &#91;&#93;[aws.guardduty.detector](aws.guardduty.detector.md) | List of GuardDuty detectors |
| ID | TYPE | DESCRIPTION |
| --------- | ------------------------------------------------------------- | --------------------------------- |
| findings | &#91;&#93;[aws.guardduty.finding](aws.guardduty.finding.md) | List of GuardDuty active findings |
| detectors | &#91;&#93;[aws.guardduty.detector](aws.guardduty.detector.md) | List of GuardDuty detectors |

**Examples**

Expand Down
9 changes: 5 additions & 4 deletions ...s/aws-pack/aws.accessanalyzer.analyzer.md → ...s-pack/aws.iam.accessanalyzer.analyzer.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: aws.accessanalyzer.analyzer
id: aws.accessanalyzer.analyzer
sidebar_label: aws.accessanalyzer.analyzer
title: aws.iam.accessanalyzer.analyzer
id: aws.iam.accessanalyzer.analyzer
sidebar_label: aws.iam.accessanalyzer.analyzer
displayed_sidebar: MQL
description: AWS IAM Access Analyzer resource (provides an object representing an individual AWS IAM Access Analyzer configuration)
---

# aws.accessanalyzer.analyzer
# aws.iam.accessanalyzer.analyzer

**Supported platform**

Expand All @@ -24,6 +24,7 @@ AWS IAM Access Analyzer resource (provides an object representing an individual
| name | string | Name for the analyzer |
| status | string | Status of the analyzer: ACTIVE, CREATING, DISABLED, or FAILED |
| type | string | Type of analyzer: ACCOUNT or ORGANIZATION |
| region | string | Region where the analyzer exists |
| tags | map[string]string | Tags for the analyzer |
| lastResourceAnalyzed | string | The name of the last resource that was analyzed |
| lastResourceAnalyzedAt | time | Last scan timestamp |
Expand Down
34 changes: 34 additions & 0 deletions docs/mql/resources/aws-pack/aws.iam.accessanalyzer.finding.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: aws.iam.accessanalyzer.finding
id: aws.iam.accessanalyzer.finding
sidebar_label: aws.iam.accessanalyzer.finding
displayed_sidebar: MQL
description: AWS IAM Access Analyzer finding
---

# aws.iam.accessanalyzer.finding

**Supported platform**

- aws

**Description**

AWS IAM Access Analyzer finding

**Fields**

| ID | TYPE | DESCRIPTION |
| -------------------- | ------ | ------------------------------- |
| id | string | Finding id |
| error | string | Error message |
| resourceArn | string | Resource |
| resourceOwnerAccount | string | Resource owner |
| resourceType | string | Resource type |
| type | string | Finding type |
| status | string | Finding status |
| analyzedAt | time | Time the finding was generated |
| createdAt | time | Creation timestamp |
| updatedAt | time | Creation timestamp |
| region | string | Region where the finding exists |
| analyzerArn | string | Analyzer ARN |
25 changes: 12 additions & 13 deletions .../resources/aws-pack/aws.accessanalyzer.md → ...ources/aws-pack/aws.iam.accessanalyzer.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: aws.accessAnalyzer
id: aws.accessAnalyzer
sidebar_label: aws.accessAnalyzer
title: aws.iam.accessAnalyzer
id: aws.iam.accessAnalyzer
sidebar_label: aws.iam.accessAnalyzer
displayed_sidebar: MQL
description: AWS IAM Access Analyzer resource (for assessing the configuration of AWS IAM Access Analyzer)
---

# aws.accessAnalyzer
# aws.iam.accessAnalyzer

**Supported platform**

Expand All @@ -16,26 +16,25 @@ description: AWS IAM Access Analyzer resource (for assessing the configuration o

AWS IAM Access Analyzer resource (for assessing the configuration of AWS IAM Access Analyzer)

The `aws.accessAnalyzer` resource returns a list AWS IAM Access Analyzers configured across the AWS account.

**Fields**

| ID | TYPE | DESCRIPTION |
| --------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| analyzers | &#91;&#93;[aws.accessanalyzer.analyzer](aws.accessanalyzer.analyzer.md) | List of `aws.accessanalyzer.analyzer` objects for all AWS IAM Access Analyzers configured within the account |
| ID | TYPE | DESCRIPTION |
| --------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| analyzers | &#91;&#93;[aws.iam.accessanalyzer.analyzer](aws.iam.accessanalyzer.analyzer.md) | List of `aws.iam.accessanalyzer.analyzer` objects for all AWS IAM Access Analyzers configured within the account |
| findings | &#91;&#93;[aws.iam.accessanalyzer.finding](aws.iam.accessanalyzer.finding.md) | List of all active findings for all analyzers and regions |

**Examples**

Return a list of AWS IAM Access Analyzers configured across the AWS account

```coffee
aws.accessAnalyzer.analyzers
aws.iam.accessAnalyzer.analyzers
```

Return a list of `aws.accessAnalyzer.analyzer` resources and the value for specified fields
Return a list of `aws.iam.accessAnalyzer.analyzer` resources and the value for specified fields

```coffee
aws.accessAnalyzer.analyzers {
aws.iam.accessAnalyzer.analyzers {
arn
name
status
Expand All @@ -46,7 +45,7 @@ aws.accessAnalyzer.analyzers {
Ensure that IAM Access analyzer is enabled for all regions

```coffee
aws.accessAnalyzer.analyzers.all(
aws.iam.accessAnalyzer.analyzers.all(
status == "ACTIVE"
)
```
Expand Down
10 changes: 5 additions & 5 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
},
"dependencies": {
"@algolia/client-search": "^4.24.0",
"@docusaurus/core": "^3.4.0",
"@docusaurus/plugin-client-redirects": "^3.4.0",
"@docusaurus/preset-classic": "^3.4.0",
"@docusaurus/theme-search-algolia": "^3.4.0",
"@docusaurus/core": "3.4.0",
"@docusaurus/plugin-client-redirects": "3.4.0",
"@docusaurus/preset-classic": "3.4.0",
"@docusaurus/theme-search-algolia": "3.4.0",
"@fontsource/roboto": "^5.0.14",
"@mdx-js/react": "^3.0.1",
"@stackql/docusaurus-plugin-hubspot": "^1.0.0",
Expand Down Expand Up @@ -58,7 +58,7 @@
]
},
"devDependencies": {
"@docusaurus/tsconfig": "^3.4.0",
"@docusaurus/tsconfig": "3.4.0",
"@types/react": "^18.3.3",
"@types/react-helmet": "^6.1.11",
"@types/react-router-dom": "^5.1.7",
Expand Down
2 changes: 1 addition & 1 deletion releases/2023-11-14-mondoo-9.7-is-out.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ AWS resources include new default values to improve data pack queries and naviga
- globalTableVersion
- id

[aws.accessanalyzer.analyzer](/mql/resources/aws-pack/aws.accessanalyzer.analyzer/)
[aws.accessanalyzer.analyzer](/mql/resources/aws-pack/aws.iam.accessanalyzer.analyzer/)

- createdAt
- lastResourceAnalyzed
Expand Down
Loading

0 comments on commit 4677b1f

Please sign in to comment.