Skip to content

Commit e0bdd0b

Browse files
authored
rds Component readme update (#667)
1 parent 85659ec commit e0bdd0b

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

modules/rds/README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,35 @@ via specific CIDR blocks or security group ids.
1313

1414
Here's an example snippet for how to use this component.
1515

16+
### PostgreSQL
17+
18+
```yaml
19+
components:
20+
terraform:
21+
rds/defaults:
22+
metadata:
23+
type: abstract
24+
vars:
25+
enabled: true
26+
use_fullname: false
27+
name: my-postgres-db
28+
instance_class: db.t3.micro
29+
database_name: my-postgres-db
30+
# database_user: admin # enable to specify something specific
31+
engine: postgres
32+
engine_version: "15.2"
33+
database_port: 5432
34+
db_parameter_group: "postgres15"
35+
allocated_storage: 10 #GBs
36+
ssm_enabled: true
37+
client_security_group_enabled: true
38+
## The following settings allow the database to be accessed from anywhere
39+
# publicly_accessible: true
40+
# use_private_subnets: false
41+
# allowed_cidr_blocks:
42+
# - 0.0.0.0/0
43+
```
44+
1645
### Microsoft SQL
1746

1847
```yaml
@@ -41,7 +70,7 @@ components:
4170
deletion_protection: false
4271
```
4372
### Provisioning from a snapshot
44-
The snapshot identifier variable can be added to provision an instance from a snapshot HOWEVER-
73+
The snapshot identifier variable can be added to provision an instance from a snapshot HOWEVER-
4574
Keep in mind these instances are provisioned from a unique kms key per rds.
4675
For clean terraform runs, you must first provision the key for the destination instance, then copy the snapshot using that kms key.
4776

0 commit comments

Comments
 (0)