Skip to content

Commit b5c62c5

Browse files
committed
Improve README files
1 parent cef92f8 commit b5c62c5

File tree

12 files changed

+37
-9
lines changed

12 files changed

+37
-9
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ with account/region security setting and security services.
1414

1515
## Submodules
1616

17-
This module is composed of several submodules and each of which can be used independently.
17+
This module is composed of several submodules, all of which can be used independently.
1818

1919
- [submodules](./modules/)
2020

2121
## Examples
2222

23-
- [examples](./examples)
23+
- [examples](./examples/)
2424

2525
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
2626
## Requirements

modules/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1+
# submodules
12

23
All modules are designed to work in a multi-account organization and to delegate administration to an administrator account (if supported by AWS)
34

4-
AWS resources that have account or regional security settings
5+
## AWS resources that have account or regional security settings
56

67
| Resource/Service | Supported | Setting |
78
| :--------------- | :--: | :---- |
@@ -11,14 +12,14 @@ AWS resources that have account or regional security settings
1112
| [iam](./baseline_iam) | yes | password policy |
1213
| [s3](./baseline_s3) | yes | public access |
1314

14-
AWS services required by Security Hub
15+
## AWS services required by [Security Hub](./securityhub)
1516

1617
| Resource/Service | Supported | Setting |
1718
| :--------------- | :--: | :---- |
1819
| [config](./config) | | setup |
1920
| [s3 buckets](./s3_bucket) | | |
2021

21-
AWS services that integrate with Security Hub
22+
## AWS services that integrate with [Security Hub](./securityhub)
2223

2324
| Service | Supported |
2425
| :---------------- | :-------: |

modules/baseline_ebs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Features
44

5-
- Enable EBS encryption by default.
5+
- Enable EBS encryption by default
66

77
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
88
## Requirements

modules/baseline_iam/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
## Features
44

55
- Set up IAM Password Policy.
6-
- Create default IAM roles for managing AWS account.
76

87
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
98
## Requirements

modules/baseline_s3/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Features
44

5-
- Enable S3 account-level Public Access Block configuration.
5+
- Enable S3 account-level Public Access Block configuration
66

77
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
88
## Requirements

modules/cloudtrail/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# AWS CloudTrail
22

3+
## Features
4+
5+
- Enable CloudTrail regions and deliver events to S3
6+
37
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
48
## Requirements
59

modules/config/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# AWS Config
22

3+
## Features
4+
5+
- Enable AWS Config
6+
37
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
48
## Requirements
59

modules/config/main.tf

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ resource "aws_config_configuration_aggregator" "organization" {
123123

124124
### SNS
125125
# Flesh out. Look at cloudposse/sns-topic/aws"
126+
#tfsec:ignore:aws-sns-enable-topic-encryption
126127
resource "aws_sns_topic" "config" {
127128
#checkov:skip=CKV_AWS_26:Allow unencrypted SNS for now
128129
count = var.enable ? 1 : 0

modules/guardduty/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# AWS GuardDuty
22

3+
## Features
4+
5+
- Enable GuardDuty
6+
37
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
48
## Requirements
59

modules/iam_access_analyzer/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# AWS Access Analyzer
22

3+
## Features
4+
5+
- Enable IAM Access Analyzer
6+
37
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
48
## Requirements
59

modules/s3_bucket/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Create secure S3 bucket in one region for AWS services
1+
# s3_bucket
2+
3+
## Features
4+
5+
- Create secure S3 bucket for AWS services
26

37
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
48
## Requirements

modules/securityhub/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# AWS Security Hub
22

3+
## Features
4+
5+
- Enable Security Hub
6+
- Delegate management to administrator account
7+
- Subscribe to standards
8+
- Subscribe to 3rd party products (optional)
9+
310
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
411
## Requirements
512

0 commit comments

Comments
 (0)