> ## Documentation Index > Fetch the complete documentation index at: https://www.ravion.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # RDS Database inputs > Reference the RDS Database module's Inputs, Database, Version, Size & Storage, Network access, Connection pooling, Availability & replicas and more inputs. **Type:** `rvn-rds` / **Latest version:** `1.4.0` See [RDS Database module reference](/docs/module-definitions/catalog/rvn-rds) for the full module page. **network** `$ref:rvn-aws-network` *required* **VPC network.** * Immutable after creation Set `network` to `null`. Mapped inputs for `network`: set these keys alongside `network`, not inside it, when supplying existing infrastructure instead of a module reference. **section\_aws** `section` **AWS account & region.** **aws\_account\_id** `string` **AWS account.** * Default: `<< ref.input.aws_account_id >>` * Immutable after creation **aws\_region** `string` **Region.** * Default: `<< ref.input.aws_region >>` * Immutable after creation **execution\_environment\_id** `string` **Terraform execution environment.** Override the VPC, subnet, and security group for Pipeline Terraform runners. Must use the same AWS account as selected above. * Default: `<< ref.input.execution_environment_id >>` **section\_vpc** `section` **VPC.** **vpc\_id** `string` *required* **VPC ID.** * Default: `<>` * Immutable after creation **subnet\_ids** `string_array` *required* **Private subnet IDs.** Subnets for the RDS DB subnet group. Use private subnets for normal database deployments. * Default: `<>` * Immutable after creation ### Database **name** `string` *required* **Name slug.** Name prefix for all RDS resources. * Default: `<>-<>` * Immutable after creation * Pattern: `^[a-z0-9]([a-z0-9-]{0,38}[a-z0-9])?$` — 1-40 lowercase letters, numbers, and hyphens. Start and end with a letter or number. **restore\_mode** `string` *required* **Create or restore.** * Default: `none` * Allowed values: `none` (New empty database), `snapshot` (Restore from snapshot), `point_in_time` (Point-in-time restore) * Immutable after creation **db\_name** `string` *required* **Database name.** * Immutable after creation * Pattern: `^[a-z][a-z0-9_]{0,63}$` — 1-64 lowercase letters, numbers, and underscores. Start with a letter. * Pattern: `^(?:|[^adimnoprst].*|a(?:|[^d].*|d(?:|[^m].*|m(?:|[^i].*|i(?:|[^n].*|n.+))))|d(?:|[^a].*|a(?:|[^t].*|t(?:|[^a].*|a(?:|[^b].*|b(?:|[^a].*|a(?:|[^s].*|s(?:|[^e].*|e(?:[^s].*|s.+))))))))|i(?:|[^n].*|n(?:|[^f].*|f(?:|[^o].*|o(?:|[^r].*|r(?:|[^m].*|m(?:|[^a].*|a(?:|[^t].*|t(?:|[^i].*|i(?:|[^o].*|o(?:|[^n].*|n(?:|[^_].*|_(?:|[^s].*|s(?:|[^c].*|c(?:|[^h].*|h(?:|[^e].*|e(?:|[^m].*|m(?:|[^a].*|a.+)))))))))))))))))|m(?:|[^y].*|y(?:|[^s].*|s(?:|[^q].*|q(?:|[^l].*|l.+))))|n(?:|[^u].*|u(?:|[^l].*|l(?:|[^l].*|l.+)))|o(?:|[^r].*|r(?:|[^a].*|a(?:|[^c].*|c(?:|[^l].*|l(?:|[^e].*|e.+)))))|p(?:|[^eo].*|e(?:|[^r].*|r(?:|[^f].*|f(?:|[^o].*|o(?:|[^r].*|r(?:|[^m].*|m(?:|[^a].*|a(?:|[^n].*|n(?:|[^c].*|c(?:|[^e].*|e(?:|[^_].*|_(?:|[^s].*|s(?:|[^c].*|c(?:|[^h].*|h(?:|[^e].*|e(?:|[^m].*|m(?:|[^a].*|a.+))))))))))))))))|o(?:|[^s].*|s(?:|[^t].*|t(?:|[^g].*|g(?:|[^r].*|r(?:|[^e].*|e(?:|[^s].*|s.+)))))))|r(?:|[^do].*|d(?:|[^s].*|s(?:|[^a].*|a(?:|[^d].*|d(?:|[^m].*|m(?:|[^i].*|i(?:|[^n].*|n.+))))))|o(?:|[^o].*|o(?:|[^t].*|t.+)))|s(?:|[^y].*|y(?:|[^s].*|s.+))|t(?:|[^e].*|e(?:|[^m].*|m(?:|[^p].*|p(?:|[^l].*|l(?:|[^a].*|a(?:|[^t].*|t(?:|[^e].*|e(?:|[^01].*|0.+|1.+)))))))))$` — Pick a different name, this is reserved by AWS. * Shown when: `{"engine":["mysql","postgres","mariadb","oracle-ee","oracle-se2","oracle-se2-cdb"],"restore_mode":"none"}` **username** `string` *required* **Username.** * Default: `dbadmin` * Immutable after creation * Pattern: `^[A-Za-z][A-Za-z0-9_]{0,62}$` — Invalid RDS master username. Start with a letter. Letters, numbers, and underscores only. * Shown when: `{"restore_mode":"none"}` **snapshot\_identifier** `string` **Snapshot to restore.** Snapshot identifier or ARN to restore into this new database. The snapshot must be compatible with the selected engine and instance settings. * Immutable after creation * Shown when: `{"restore_mode":"snapshot"}` **point\_in\_time\_use\_latest\_restorable\_time** `boolean` **Use latest restorable time.** Restore to the latest time AWS can recover from the selected source database backup. * Default: `true` * Immutable after creation * Shown when: `{"restore_mode":"point_in_time"}` **point\_in\_time\_restore\_time** `string` **Restore time.** Restore to this UTC timestamp instead of the latest restorable time. * Immutable after creation * Shown when: `{"point_in_time_use_latest_restorable_time":false,"restore_mode":"point_in_time"}` **point\_in\_time\_source\_db\_instance\_identifier** `string` **Source DB instance identifier.** Source DB instance identifier to restore from. * Immutable after creation * Shown when: `{"restore_mode":"point_in_time"}` **point\_in\_time\_source\_db\_instance\_automated\_backups\_arn** `string` **Source automated backups ARN.** ARN of the source automated backups to restore from. Use this for cross-region or retained automated backup restores. * Immutable after creation * Shown when: `{"restore_mode":"point_in_time"}` **point\_in\_time\_source\_dbi\_resource\_id** `string` **Source DB resource ID.** Source DB resource ID to restore from when using automated backups. * Immutable after creation * Shown when: `{"restore_mode":"point_in_time"}` ### Version **engine** `string` *required* **Engine.** * Default: `postgres` * Allowed values: `postgres` (PostgreSQL), `mysql` (MySQL), `mariadb` (MariaDB), `oracle-ee` (Oracle Enterprise Edition), `oracle-se2` (Oracle Standard Edition 2), `oracle-se2-cdb` (Oracle Standard Edition 2 CDB), `sqlserver-ee` (SQL Server Enterprise), `sqlserver-se` (SQL Server Standard), `sqlserver-ex` (SQL Server Express), `sqlserver-web` (SQL Server Web) * Immutable after creation **engine\_major\_version** `string` *required* **Engine major version.** Examples: 15 for PostgreSQL or SQL Server, 8.0 for MySQL, 19 for Oracle. **engine\_minor\_version** `string` **Engine minor version.** Optional minor engine version appended to the major version. Example: major 15 and minor 4 becomes 15.4. **minor\_version\_auto\_upgrade\_enabled** `boolean` **Auto minor version upgrades.** Enable automatic minor engine version upgrades during the configured maintenance window. * Default: `true` ### Size & Storage **instance\_class** `string` *required* **Instance class.** RDS instance size, such as db.t4g.micro or db.r6g.large. * Default: `db.t4g.micro` **allocated\_storage** `number` *required* **Allocated storage (GiB).** AWS supports increasing allocated storage after creation, but not reducing it in place. * Default: `20` * Min: `20` * Max: `65536` **max\_allocated\_storage** `number` **Max allocated storage (GiB).** Upper limit for RDS storage autoscaling. Use 0 to disable. AWS can grow storage up to this limit, but storage cannot be reduced in place. * Default: `0` * Min: `0` * Max: `65536` **storage\_type** `string` **Storage type.** * Default: `gp3` * Allowed values: `gp3`, `gp2`, `io1`, `io2`, `standard` **iops** `number` **Provisioned IOPS.** * Min: `1000` * Max: `256000` * Shown when: `{"storage_type":["gp3","io1","io2"]}` **storage\_throughput** `number` **Storage throughput (MiB/s).** * Min: `125` * Max: `1000` * Shown when: `{"storage_type":"gp3"}` **kms\_key\_id** `string` **Storage KMS key ARN.** * Immutable after creation **ca\_cert\_identifier** `string` **CA certificate identifier.** ### Network access **public\_access\_enabled** `boolean` **Publicly accessible.** Keep disabled for production databases unless public access is intentional. * Default: `false` **port** `number` **Port.** Leave blank to use the engine default port. * Min: `1` * Max: `65535` **security\_group\_creation\_enabled** `boolean` **Security group creation.** * Default: `true` * Immutable after creation **security\_group\_id** `string` **Existing security group ID.** * Shown when: `{"security_group_creation_enabled":false}` **allowed\_security\_group\_ids** `string_array` **Allowed security groups.** * Shown when: `{"security_group_creation_enabled":true}` **allowed\_cidr\_blocks** `string_array` **Allowed CIDR blocks.** * Shown when: `{"security_group_creation_enabled":true}` ### Connection pooling **proxy\_creation\_enabled** `boolean` **RDS Proxy.** Create an RDS Proxy in front of the database for connection pooling and improved failover handling. Applications keep connecting to the database endpoint until you update their connection string to the proxy endpoint output. * Default: `false` * Shown when: `{"engine":["mysql","postgres","mariadb","sqlserver-ee","sqlserver-se","sqlserver-ex","sqlserver-web"]}` **proxy\_auth\_secret\_arns** `string_array` **Auth secret ARNs.** Secrets Manager secrets containing database credentials for the proxy. Leave blank to use the managed master user secret. * Shown when: `{"proxy_creation_enabled":true}` **proxy\_secret\_kms\_key\_arns** `string_array` **Auth secret KMS key ARNs.** KMS keys used to encrypt the auth secrets when using customer-managed keys. The master user secret KMS key is included automatically. * Shown when: `{"proxy_creation_enabled":true}` **proxy\_iam\_auth\_enabled** `boolean` **IAM authentication.** Require IAM authentication for client connections to the proxy. * Default: `false` * Shown when: `{"proxy_creation_enabled":true}` **proxy\_tls\_requirement\_enabled** `boolean` **Require TLS.** Require TLS for client connections to the proxy. * Default: `true` * Shown when: `{"proxy_creation_enabled":true}` **proxy\_debug\_logging\_enabled** `boolean` **Debug logging.** Log detailed connection information, including SQL statements, to CloudWatch Logs. * Default: `false` * Shown when: `{"proxy_creation_enabled":true}` **proxy\_idle\_client\_timeout** `number` **Idle client timeout (seconds).** * Default: `1800` * Min: `1` * Max: `28800` * Shown when: `{"proxy_creation_enabled":true}` **proxy\_connection\_borrow\_timeout** `number` **Connection borrow timeout (seconds).** * Default: `120` * Min: `0` * Shown when: `{"proxy_creation_enabled":true}` **proxy\_max\_connections\_percent** `number` **Max connections (%).** Maximum size of the connection pool as a percentage of the database max\_connections setting. * Default: `100` * Min: `1` * Max: `100` * Shown when: `{"proxy_creation_enabled":true}` **proxy\_max\_idle\_connections\_percent** `number` **Max idle connections (%).** Maximum idle connections kept open, as a percentage of the database max\_connections setting. * Default: `50` * Min: `0` * Max: `100` * Shown when: `{"proxy_creation_enabled":true}` **proxy\_session\_pinning\_filters** `string_array` **Session pinning filters.** * Allowed values: `EXCLUDE_VARIABLE_SETS` * Shown when: `{"proxy_creation_enabled":true}` **proxy\_init\_query** `string` **Initialization query.** SQL statements the proxy runs when opening each new database connection. * Shown when: `{"proxy_creation_enabled":true}` ### Availability & replicas **multi\_az\_enabled** `boolean` **Multi-AZ.** * Default: `false` **availability\_zone** `string` **Availability zone.** Single-AZ placement. Hidden when Multi-AZ is enabled because AWS chooses standby placement. * Shown when: `{"multi_az_enabled":false}` **read\_replica\_creation\_enabled** `boolean` **Read replicas.** * Default: `false` * Shown when: `{"engine":["mysql","postgres","mariadb","oracle-ee","oracle-se2","oracle-se2-cdb"]}` **read\_replica\_count** `number` **Read replica count.** * Default: `1` * Min: `0` * Max: `15` * Shown when: `{"engine":["mysql","postgres","mariadb","oracle-ee","oracle-se2","oracle-se2-cdb"],"read_replica_creation_enabled":true}` **read\_replica\_instance\_class** `string` **Read replica instance class.** * Shown when: `{"engine":["mysql","postgres","mariadb","oracle-ee","oracle-se2","oracle-se2-cdb"],"read_replica_creation_enabled":true}` **read\_replica\_availability\_zones** `string_array` **Read replica AZs.** * Shown when: `{"engine":["mysql","postgres","mariadb","oracle-ee","oracle-se2","oracle-se2-cdb"],"read_replica_creation_enabled":true}` ### Credentials & authentication **master\_user\_password\_management\_enabled** `boolean` **Manage password in Secrets Manager.** Let AWS generate and manage the master password in Secrets Manager. Disable before importing a database whose existing password is managed externally. * Default: `true` **master\_user\_password\_preservation\_enabled** `boolean` **Preserve existing master password.** Preserve the externally managed password of an imported database. Ravion verifies that the named database already exists in AWS. * Default: `false` * Shown when: `{"master_user_password_management_enabled":false}` **master\_user\_secret\_kms\_key\_id** `string` **Secrets Manager KMS key ARN.** * Shown when: `{"master_user_password_management_enabled":true,"restore_mode":"none"}` **iam\_database\_authentication\_enabled** `boolean` **IAM database authentication.** * Default: `false` * Shown when: `{"engine":["mysql","postgres"]}` ### SQL Server settings **license\_model\_sqlserver** `string` **License model.** * Allowed values: `license-included`, `bring-your-own-license` * Immutable after creation * Shown when: `{"engine":["sqlserver-ee","sqlserver-se","sqlserver-ex","sqlserver-web"]}` **character\_set\_name\_sqlserver** `string` **Character set.** * Immutable after creation * Shown when: `{"engine":["sqlserver-ee","sqlserver-se","sqlserver-ex","sqlserver-web"]}` **timezone** `string` **SQL Server time zone.** * Immutable after creation * Shown when: `{"engine":["sqlserver-ee","sqlserver-se","sqlserver-ex","sqlserver-web"]}` **domain** `string` **Active Directory directory ID.** * Immutable after creation * Shown when: `{"engine":["sqlserver-ee","sqlserver-se","sqlserver-ex","sqlserver-web"]}` **domain\_iam\_role\_name** `string` **Active Directory IAM role name.** * Immutable after creation * Shown when: `{"domain":{"not":""},"engine":["sqlserver-ee","sqlserver-se","sqlserver-ex","sqlserver-web"]}` ### Oracle settings **license\_model\_oracle** `string` **License model.** * Allowed values: `license-included`, `bring-your-own-license` * Immutable after creation * Shown when: `{"engine":["oracle-ee","oracle-se2","oracle-se2-cdb"]}` **character\_set\_name\_oracle** `string` **Character set.** * Immutable after creation * Shown when: `{"engine":["oracle-ee","oracle-se2","oracle-se2-cdb"]}` ### Backups **backup\_retention\_period** `number` **Backup retention days.** * Default: `7` * Min: `0` * Max: `35` **backup\_window** `string` **Backup window.** * Shown when: `{"backup_retention_period":{"not":0}}` **snapshot\_tag\_copying\_enabled** `boolean` **Copy tags to snapshots.** * Default: `true` **automated\_backups\_deletion\_enabled** `boolean` **Delete automated backups.** Delete retained automated backups when the database is deleted. Disable this to preserve automated backups after deletion. * Default: `true` * Shown when: `{"backup_retention_period":{"not":0}}` **final\_snapshot\_creation\_enabled** `boolean` **Create final snapshot.** * Default: `true` **final\_snapshot\_identifier** `string` **Final snapshot identifier.** * Shown when: `{"final_snapshot_creation_enabled":true}` **deletion\_protection\_enabled** `boolean` **Deletion protection.** * Default: `true` ### Maintenance **maintenance\_window** `string` **Maintenance window.** **major\_version\_upgrade\_enabled** `boolean` **Allow major version upgrades.** * Default: `false` **immediate\_apply\_enabled** `boolean` **Apply changes immediately.** * Default: `false` ### Monitoring **enabled\_cloudwatch\_logs\_exports** `string_array` **CloudWatch log exports.** **monitoring\_interval** `number` **Enhanced monitoring interval.** * Default: `0` * Allowed values: `0` (0), `1` (1), `5` (5), `10` (10), `15` (15), `30` (30), `60` (60) **monitoring\_role\_creation\_enabled** `boolean` **Monitoring IAM role creation.** * Default: `true` * Immutable after creation * Shown when: `{"monitoring_interval":{"not":0}}` **monitoring\_role\_arn** `string` **Monitoring IAM role ARN.** * Shown when: `{"monitoring_interval":{"not":0},"monitoring_role_creation_enabled":false}` **performance\_insights\_enabled** `boolean` **Performance insights.** * Default: `true` **performance\_insights\_retention\_period** `number` **Performance insights retention days.** * Default: `7` * Shown when: `{"performance_insights_enabled":true}` **performance\_insights\_kms\_key\_id** `string` **Performance insights KMS key ARN.** * Shown when: `{"performance_insights_enabled":true}` ### CloudWatch alarms **cloudwatch\_alarms\_creation\_enabled** `boolean` **Create CloudWatch alarms.** * Default: `true` **cloudwatch\_alarm\_cpu\_threshold** `number` **CPU alarm threshold (%).** * Default: `80` * Min: `0` * Max: `100` * Shown when: `{"cloudwatch_alarms_creation_enabled":true}` **cloudwatch\_alarm\_storage\_threshold\_gib** `number` **Free storage alarm threshold (GiB).** Triggers when the primary instance's period average falls below this value. * Default: `5` * Min: `0` * Shown when: `{"cloudwatch_alarms_creation_enabled":true}` **cloudwatch\_alarm\_read\_iops\_threshold** `number` **Read IOPS alarm threshold.** Average for the primary instance, in operations per second. Tune to workload capacity. * Default: `1000` * Min: `1` * Shown when: `{"cloudwatch_alarms_creation_enabled":true}` **cloudwatch\_alarm\_write\_iops\_threshold** `number` **Write IOPS alarm threshold.** Average for the primary instance, in operations per second. Tune to workload capacity. * Default: `1000` * Min: `1` * Shown when: `{"cloudwatch_alarms_creation_enabled":true}` **cloudwatch\_alarm\_connections\_threshold** `number` **Connections alarm threshold.** * Default: `100` * Min: `1` * Shown when: `{"cloudwatch_alarms_creation_enabled":true}` **cloudwatch\_alarm\_evaluation\_periods** `number` **Alarm evaluation periods.** * Default: `2` * Min: `1` * Shown when: `{"cloudwatch_alarms_creation_enabled":true}` **cloudwatch\_alarm\_period** `number` **Alarm period seconds.** I/O uses at least one minute; other metrics use this value. * Default: `300` * Allowed values: `10` (10), `30` (30), `60` (60), `300` (300), `900` (900), `3600` (3600) * Shown when: `{"cloudwatch_alarms_creation_enabled":true}` **cloudwatch\_alarm\_actions** `string_array` **Alarm action ARNs.** * Shown when: `{"cloudwatch_alarms_creation_enabled":true}` **cloudwatch\_ok\_actions** `string_array` **OK action ARNs.** * Shown when: `{"cloudwatch_alarms_creation_enabled":true}` ### Parameter group **parameter\_group\_creation\_enabled** `boolean` **Parameter group creation.** Create a parameter group for this database. Disable this only when you want to attach an existing parameter group. * Default: `true` * Immutable after creation **parameter\_group\_name** `string` **Existing parameter group name.** Name of an existing parameter group to attach when this module is not creating one. * Immutable after creation * Shown when: `{"parameter_group_creation_enabled":false}` **parameter\_group\_family** `string` **Parameter group family.** Parameter group family, such as postgres15 or mysql8.0. Leave blank to derive it from the selected engine and major version. * Immutable after creation * Shown when: `{"parameter_group_creation_enabled":true}` **parameters** `object_array` **Parameters.** Custom database engine parameters to apply to the created parameter group. Many changes require a database reboot depending on the parameter. * Default: `[]` * Shown when: `{"parameter_group_creation_enabled":true}` **item fields** **name** `string` *required* **Name.** Engine parameter name, such as log\_statement or max\_connections. **value** `string` *required* **Value.** Parameter value to set. **apply\_method** `string` **Apply method.** Apply immediately when supported, or wait until the next database reboot. * Default: `immediate` * Allowed values: `immediate`, `pending-reboot` ### Option group **option\_group\_creation\_enabled** `boolean` **Option group creation.** * Default: `false` * Immutable after creation * Shown when: `{"engine":["oracle-ee","oracle-se2","oracle-se2-cdb","sqlserver-ee","sqlserver-se","sqlserver-ex","sqlserver-web"]}` **option\_group\_name** `string` **Existing option group name.** * Immutable after creation * Shown when: `{"engine":["oracle-ee","oracle-se2","oracle-se2-cdb","sqlserver-ee","sqlserver-se","sqlserver-ex","sqlserver-web"],"option_group_creation_enabled":false}` **option\_group\_engine\_version** `string` **Option group engine version.** * Immutable after creation * Shown when: `{"engine":["oracle-ee","oracle-se2","oracle-se2-cdb","sqlserver-ee","sqlserver-se","sqlserver-ex","sqlserver-web"],"option_group_creation_enabled":true}` **options** `array` **Options.** * Default: `[]` * Shown when: `{"engine":["oracle-ee","oracle-se2","oracle-se2-cdb","sqlserver-ee","sqlserver-se","sqlserver-ex","sqlserver-web"],"option_group_creation_enabled":true}` ### Blue/green deployments **blue\_green\_update\_enabled** `boolean` **Blue/green updates.** * Default: `false` * Shown when: `{"engine":["mysql","mariadb"]}` ### Misc **tags** `keyvalue` **Tags.** A map of tags to assign to all resources. Default tags are `Owner`, `ProjectGivenId`, `EnvironmentGivenId`, `ModuleGivenId`, `ModuleId` ### Terraform settings **opentofu\_version** `string` **OpenTofu version override.** Override the environment's default version for this module **ravion\_state\_backend\_workspace** `string` **Ravion Terraform workspace name.** Override Terraform state backend workspace name. Defaults to project + environment + module given ids. * Immutable after creation **terraform\_plan\_default\_policies\_enabled** `boolean` **Include default plan policies.** Turn off to plan with only the policies below instead of the default read-only policies. Requires at least one policy below. * Default: `true` **terraform\_plan\_iam\_policy\_arns** `string_array` **Terraform plan IAM policies.** IAM managed policy ARNs for the Terraform plan runner role. Without default policies, allow s3:CreateBucket, s3:PutObject, s3:GetObject, and s3:ListBucket on the ravion-terraform-plans-\ bucket in this account. * Default: `[]` **terraform\_apply\_default\_policies\_enabled** `boolean` **Include default apply policies.** Turn off to apply and destroy with only the policies below instead of AdministratorAccess. Requires at least one policy below. * Default: `true` **terraform\_apply\_iam\_policy\_arns** `string_array` **Terraform apply IAM policies.** IAM managed policy ARNs for the Terraform apply runner role. Without default policies, allow s3:CreateBucket, s3:PutObject, s3:GetObject, and s3:ListBucket on the ravion-terraform-plans-\ bucket in this account. * Default: `[]` **advanced\_terraform\_variables** `object` **Advanced Terraform variables.** Optional raw Terraform variable overrides for advanced module inputs or one-off overrides. Values here override the generated variables above. * Default: `{}` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.