Skip to content

Commit 398ccbf

Browse files
terraform-docs: automated action
1 parent 520fcfc commit 398ccbf

File tree

2 files changed

+31
-2
lines changed

2 files changed

+31
-2
lines changed

modules/iam-role/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
<!-- BEGIN_TF_DOCS -->
22
# iam-role
33

4-
This sub-module creates IAM role and attaches appropriate IAM policies to the IAM role.
4+
This sub-module creates an IAM role and attaches appropriate IAM policies to the IAM role.
5+
6+
## Presets
7+
8+
### IAM Role
9+
10+
- The `name` is marked as a required variable, which sets the name of the IAM role.
11+
12+
## Notes
13+
14+
- The IAM policies defined under `iam_policies` are created and automatically attached to the IAM role.
15+
- The ARNs of the IAM policies specified under the `iam_policy_attachments` are automatically attached to the IAM role. This is useful in cases where you are referencing:
16+
- Amazon-managed IAM Policies, or
17+
- Self-managed IAM Policies
518

619
## Requirements
720

modules/rds/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,23 @@
11
<!-- BEGIN_TF_DOCS -->
22
# rds
33

4-
This sub-module creates an RDS instance.
4+
This sub-module creates:
5+
- RDS instance
6+
- DB Subnet Group, and
7+
- DB Parameter Group
8+
9+
## Presets
10+
11+
### DB Instance
12+
13+
- The `storage_type` is set to "gp2" (General Purpose SSD) as the default choice (instead of "io1", which requires Iops), and can be overridden to use any other Storage type.
14+
- The `db_name` is set to "default\_db" as the default database name, and can be overridden.
15+
- The `username` is set to "admin\_user" as the default master user's username, and can be overridden.
16+
- The `skip_final_snapshot` is set to `true` as the default choice (which skips the creation of DB snapshots when the RDS instance is destroyed), and can be overridden to be `false`.
17+
18+
## Notes
19+
20+
- The `family` attribute under DB Parameter Group is marked as required.
521

622
## Requirements
723

0 commit comments

Comments
 (0)