Skip to content

Commit

Permalink
fixed documentation broken links
Browse files Browse the repository at this point in the history
Signed-off-by: Nima Fotouhi <[email protected]>
  • Loading branch information
nimaft committed Nov 17, 2023
1 parent ca3ba99 commit 8ff597e
Show file tree
Hide file tree
Showing 9 changed files with 6 additions and 6 deletions.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ rdk sample-ci <Resource Type>

to output a formatted JSON document.

For a deeper dive on how to create RDK rules visit [Creating Rules](./creating-and-editing-rules/creating-rules.md).
For a deeper dive on how to create RDK rules visit [Creating Rules](./rule-management/creating-rules.md).

### Write and Run Unit Tests

Expand Down
6 changes: 3 additions & 3 deletions docs/rule-management/creating-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@ Run `rdk create IAM_ROLE --runtime python3.11 --resource-types AWS::IAM::Role`.

When you use `--resource-types or -r` options, you are implicitly setting your rule’s trigger type to configuration changes, so when you deploy this rule, you will see Oversized configuration changes and Configuration changes under Detective evaluation trigger type in your rule’s detail page on AWS Config console:

![configuration change triggered rule](../../images/config_change_triggered.jpeg)
![configuration change triggered rule](../images/config_change_triggered.jpeg)

### Creating a periodically triggered rule to assess IAM roles’ compliance

Run `rdk create IAM_ROLE --runtime python3.11 --maximum-frequency Six_Hours`. Using the `-m, or --maximum-frequency` option, implicitly sets your rule’s trigger type to periodic, so when you deploy this rule, you will see Periodic: 6 hours under Detective evaluation trigger type in your rule’s detail page on AWS Config console:

![periodically triggered rule](../../images/config_periodic.jpeg)
![periodically triggered rule](../images/config_periodic.jpeg)

Note that _Scope of Changes_ is empty because this is a periodically triggered role.

Expand All @@ -76,4 +76,4 @@ Run `rdk create IAM_ROLE --runtime python3.11 --maximum-frequency Six_Hours --re

This rule is triggered every six hours, and every time there is a change in _AWS::IAM::Role_ or _AWS::IAM::Policy_ resource types. When you deploy this rule you will see _Oversized configuration changes, Periodic: 6 hours_ and _Configuration changes_ under _Detective evaluation trigger type_ in your rule’s detail page on AWS Config console, you should also see two different resource types under _Resource types_:

![Hybrid rule with input parameters](../../images/config_hybrid.jpeg)
![Hybrid rule with input parameters](../images/config_hybrid.jpeg)
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Here are the highlights of what the lambda_handler function does:

### Validating compliance results, and reporting back to AWS Config

When you create your AWS Config rule files using `rdk create` command, your Lambda function file has an empty evaluate_compliance function which you need to populate with your compliance evaluation logic and return the compliance result (see the [Writing an evaluate_compliance function](Writing%20an%20evaluate_compliance%20function.md) for guidance on updating this function). Compliance results is expected to be a string, a dictionary or a list of dictionaries containing the following keys:
When you create your AWS Config rule files using `rdk create` command, your Lambda function file has an empty evaluate_compliance function which you need to populate with your compliance evaluation logic and return the compliance result (see the [Writing an evaluate_compliance function](writing-an-evaluate_compliance-function.md) for guidance on updating this function). Compliance results is expected to be a string, a dictionary or a list of dictionaries containing the following keys:

- `ComplianceResourceType`
- `ComplianceResourceId`
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ theme:
name: material
palette:
scheme: default
primary: orange
primary: navy
plugins:
- search
# TODO: Enable this if/when docstrings are expanded in the core rdk module.
Expand Down

0 comments on commit 8ff597e

Please sign in to comment.