Skip to content

Commit 31f014d

Browse files
committed
docs(modules/rds): add presets and notes
1 parent 7c06792 commit 31f014d

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

modules/rds/.header.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
11
# rds
22

3-
This sub-module creates an RDS instance.
3+
This sub-module creates:
4+
- RDS instance
5+
- DB Subnet Group, and
6+
- DB Parameter Group
7+
8+
## Presets
9+
10+
### DB Instance
11+
12+
- 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.
13+
- The `db_name` is set to "default_db" as the default database name, and can be overridden.
14+
- The `username` is set to "admin_user" as the default master user's username, and can be overridden.
15+
- 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`.
16+
17+
## Notes
18+
19+
- The `family` attribute under DB Parameter Group is marked as required.

0 commit comments

Comments
 (0)