> ## 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.

# Aurora Database inputs: Inputs to global database

> Reference the Aurora Database module's Inputs, Database, Version, Capacity, Storage & cluster, Network access, Connection pooling, Readers and more inputs.

**Type:** `rvn-aurora` / **Latest version:** `1.5.0`

See [Aurora Database module reference](/docs/module-definitions/catalog/rvn-aurora) 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: `<<ref.stack.output.vpc_id>>`
* Immutable after creation

**private\_subnet\_ids** `string_array` *required*

**Private subnet IDs.** Used for the Aurora DB subnet group when the database is not publicly accessible. Use at least two subnets in different Availability Zones.

* Default: `<<ref.stack.output.private_subnet_ids>>`
* Immutable after creation

**public\_subnet\_ids** `string_array`

**Public subnet IDs.** Used for the Aurora DB subnet group when Publicly accessible is enabled. AWS requires public subnets for public database access.

* Default: `<<ref.stack.output.public_subnet_ids>>`
* Immutable after creation
* Shown when: `{"public_access_enabled":true}`

### Database

**name** `string` *required*

**Name slug.** Name of the Aurora cluster and prefix for related resources.

* Default: `<<project.given_id>>-<<environment.given_id>>`
* Immutable after creation
* Pattern: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$` — 1-63 lowercase letters, numbers, and hyphens. Start with a letter 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

**database\_name** `string`

**Database name.** Name for an automatically created database on the cluster.

* Immutable after creation
* Pattern: `^[A-Za-z][A-Za-z0-9_]{0,63}$` — 1-64 letters, numbers, and underscores. Start with a letter.
* Shown when: `{"restore_mode":"none"}`

**master\_username** `string` *required*

**Username.**

* Default: `dbadmin`
* Immutable after creation
* Pattern: `^[A-Za-z][A-Za-z0-9_]{0,62}$` — Invalid Aurora master username. Start with a letter. Letters, numbers, and underscores only.
* Shown when: `{"restore_mode":"none"}`

**snapshot\_identifier** `string` *required*

**Snapshot to restore.** Snapshot identifier or ARN to restore into this new Aurora cluster.

* Immutable after creation
* Shown when: `{"restore_mode":"snapshot"}`

**point\_in\_time\_source\_cluster\_identifier** `string` *required*

**Source cluster identifier.** Source Aurora cluster identifier to restore from.

* Immutable after creation
* Shown when: `{"restore_mode":"point_in_time"}`

**point\_in\_time\_restore\_type** `string` *required*

**Restore type.**

* Default: `full-copy`
* Allowed values: `full-copy` (Full copy), `copy-on-write` (Copy on write)
* Immutable after creation
* Shown when: `{"restore_mode":"point_in_time"}`

**point\_in\_time\_use\_latest\_restorable\_time** `boolean`

**Use latest restorable time.** Restore to the latest time AWS can recover from the selected source cluster 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"}`

### Version

**engine** `string` *required*

**Engine.**

* Default: `aurora-postgresql`
* Allowed values: `aurora-postgresql` (Aurora PostgreSQL), `aurora-mysql` (Aurora MySQL)
* Immutable after creation

**engine\_major\_version** `string` *required*

**Engine major version.** Examples: 16 for Aurora PostgreSQL or 8.0 for Aurora MySQL.

**engine\_minor\_version** `string`

**Engine minor version.** Optional minor engine version appended to the major version. Example: 4 becomes 16.4 for Aurora PostgreSQL; 3.08.0 becomes 8.0.mysql\_aurora.3.08.0 for Aurora MySQL.

**minor\_version\_auto\_upgrade\_enabled** `boolean`

**Auto minor version upgrades.** Enable automatic minor engine version upgrades during the configured maintenance window.

* Default: `true`

### Capacity

**capacity\_mode** `string` *required*

**Capacity mode.** Choose fixed DB instances or Aurora Serverless v2 capacity.

* Default: `provisioned`
* Allowed values: `provisioned` (Provisioned instances), `serverless_v2` (Serverless v2)

**instance\_class** `string` *required*

**Instance class.** Aurora writer instance size, such as db.t4g.medium or db.r6g.large.

* Default: `db.t4g.medium`
* Shown when: `{"capacity_mode":"provisioned"}`

**serverless\_min\_capacity** `number` *required*

**Min capacity (ACUs).** Minimum Aurora Serverless v2 capacity units. Must not exceed max capacity.

* Default: `1`
* Min: `1`
* Max: `256`
* Shown when: `{"capacity_mode":"serverless_v2"}`

**serverless\_max\_capacity** `number` *required*

**Max capacity (ACUs).** Maximum Aurora Serverless v2 capacity units. Must be at least min capacity.

* Default: `4`
* Min: `1`
* Max: `256`
* Shown when: `{"capacity_mode":"serverless_v2"}`

### Storage & cluster

**storage\_type** `string`

**Storage type.**

* Default: `aurora`
* Allowed values: `aurora` (Aurora Standard), `aurora-iopt1` (Aurora I/O-Optimized)

**kms\_key\_id** `string`

**Storage KMS key ARN.**

* Immutable after creation

**ca\_certificate\_identifier** `string`

**CA certificate identifier.**

**network\_type** `string`

**Network type.**

* Default: `IPV4`
* Allowed values: `IPV4` (IPv4), `DUAL` (Dual-stack)

### 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: 5432 for PostgreSQL or 3306 for MySQL.

* 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 cluster for connection pooling and improved failover handling. Applications keep connecting to the cluster endpoint until you update their connection string to the proxy endpoint output.

* Default: `false`

**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}`

### Readers

**reader\_count** `number`

**Reader count.** Number of reader instances to create.

* Default: `0`
* Min: `0`
* Max: `15`

**reader\_instance\_class** `string`

**Reader instance class.** Reader instance class. Leave blank to use the writer instance class.

* Shown when: `{"capacity_mode":"provisioned"}`

**promotion\_tier** `number`

**Promotion tier.** Default failover priority for instances. Lower values have higher priority.

* Min: `0`
* Max: `15`

**autoscaling\_enabled** `boolean`

**Reader autoscaling.**

* Default: `false`

**autoscaling\_min\_capacity** `number`

**Min reader capacity.** Must not exceed max reader capacity.

* Default: `1`
* Min: `0`
* Shown when: `{"autoscaling_enabled":true}`

**autoscaling\_max\_capacity** `number`

**Max reader capacity.** Must be at least min reader capacity.

* Default: `3`
* Min: `1`
* Shown when: `{"autoscaling_enabled":true}`

**autoscaling\_target\_cpu** `number`

**Target CPU utilization (%).**

* Default: `70`
* Min: `1`
* Max: `100`
* Shown when: `{"autoscaling_enabled":true}`

**autoscaling\_target\_connections** `number`

**Target connections.**

* Min: `1`
* Shown when: `{"autoscaling_enabled":true}`

**autoscaling\_scale\_in\_cooldown** `number`

**Scale-in cooldown seconds.**

* Default: `300`
* Min: `0`
* Shown when: `{"autoscaling_enabled":true}`

**autoscaling\_scale\_out\_cooldown** `number`

**Scale-out cooldown seconds.**

* Default: `300`
* Min: `0`
* Shown when: `{"autoscaling_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. Turn off to name the secret yourself, or before importing a cluster 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 cluster. Ravion verifies that the named cluster already exists in AWS.

* Default: `false`
* Shown when: `{"master_user_password_management_enabled":false}`

**master\_user\_secret\_name** `string`

**Master password secret name.** Generate the master password and store it in a Secrets Manager secret with this name, such as prod/app/db. Not rotated automatically; the password stays out of Terraform state.

* Pattern: `^[A-Za-z0-9/_+=.@-]{1,512}$` — 1-512 letters, numbers, and / \_ + = . @ - characters.
* Shown when: `{"master_user_password_management_enabled":false,"master_user_password_preservation_enabled":false,"restore_mode":"none"}`

**master\_user\_secret\_version** `number`

**Master password version.** Increment to generate a new password and write it to the cluster and the secret on the next deploy.

* Default: `1`
* Min: `1`
* Shown when: `{"master_user_password_management_enabled":false,"master_user_password_preservation_enabled":false,"restore_mode":"none"}`

**master\_user\_secret\_kms\_key\_id** `string`

**Secrets Manager KMS key ARN.**

* Shown when: `{"restore_mode":"none"}`

**iam\_database\_authentication\_enabled** `boolean`

**IAM database authentication.**

* Default: `false`

**http\_endpoint\_enabled** `boolean`

**Data API (HTTP endpoint).** Enable the Aurora Data API HTTP endpoint.

* Default: `false`

### MySQL settings

**backtrack\_window** `number`

**Backtrack window (seconds).** Target backtrack window in seconds. Set 0 to disable.

* Default: `0`
* Min: `0`
* Max: `259200`
* Shown when: `{"engine":"aurora-mysql"}`

**local\_write\_forwarding\_enabled** `boolean`

**Local write forwarding.**

* Default: `false`
* Shown when: `{"engine":"aurora-mysql"}`

### Backups

**backup\_retention\_period** `number`

**Backup retention days.**

* Default: `7`
* Min: `1`
* Max: `35`

**preferred\_backup\_window** `string`

**Backup window.**

**snapshot\_tag\_copying\_enabled** `boolean`

**Copy tags to snapshots.**

* Default: `true`

**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

**preferred\_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`

### Parameter groups

**cluster\_parameter\_group\_creation\_enabled** `boolean`

**Cluster parameter group creation.** Create a cluster parameter group for this database. Disable this only when you want to attach an existing parameter group.

* Default: `true`
* Immutable after creation

**cluster\_parameter\_group\_name** `string`

**Existing cluster parameter group name.** Name of an existing cluster parameter group to attach when this module is not creating one.

* Immutable after creation
* Shown when: `{"cluster_parameter_group_creation_enabled":false}`

**cluster\_parameter\_group\_family** `string`

**Cluster parameter group family.** Cluster parameter group family. Leave blank to derive it from the selected engine version.

* Immutable after creation
* Shown when: `{"cluster_parameter_group_creation_enabled":true}`

**cluster\_parameters** `object_array`

**Cluster parameters.** Custom cluster parameters to apply to the created cluster parameter group.

* Default: `[]`
* Shown when: `{"cluster_parameter_group_creation_enabled":true}`

**item fields**

**name** `string` *required*

**Name.** Engine parameter name, such as rds.force\_ssl.

**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`

**db\_parameter\_group\_creation\_enabled** `boolean`

**DB parameter group creation.** Create a DB parameter group for cluster instances. Disable this only when you want to attach an existing parameter group.

* Default: `true`
* Immutable after creation

**db\_parameter\_group\_name** `string`

**Existing DB parameter group name.** Name of an existing DB parameter group to attach when this module is not creating one.

* Immutable after creation
* Shown when: `{"db_parameter_group_creation_enabled":false}`

**db\_parameter\_group\_family** `string`

**DB parameter group family.** DB parameter group family. Leave blank to derive it from the selected engine version.

* Immutable after creation
* Shown when: `{"db_parameter_group_creation_enabled":true}`

**db\_parameters** `object_array`

**DB parameters.** Custom instance parameters to apply to the created DB parameter group.

* Default: `[]`
* Shown when: `{"db_parameter_group_creation_enabled":true}`

**item fields**

**name** `string` *required*

**Name.** Engine parameter name, such as shared\_preload\_libraries.

**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`

### Monitoring

**enabled\_cloudwatch\_logs\_exports** `string_array`

**CloudWatch log exports.** Engine logs exported to CloudWatch. Each enabled log type is shown on the module Logs tab.

* Allowed values: `postgresql`, `audit`, `error`, `general`, `slowquery`

**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.** AWS supports 7 days, multiples of 31 days up to 23 months, or 731 days.

* Default: `7`
* Allowed values: `7` (7 days), `31` (1 month (31 days)), `62` (2 months (62 days)), `93` (3 months (93 days)), `186` (6 months (186 days)), `372` (12 months (372 days)), `731` (24 months (731 days))
* 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\_memory\_threshold\_mib** `number`

**Freeable memory alarm threshold (MiB).** Triggers when the cluster average falls below this value.

* Default: `256`
* Min: `1`
* Shown when: `{"cloudwatch_alarms_creation_enabled":true}`

**cloudwatch\_alarm\_storage\_threshold\_gib** `number`

**Remaining storage alarm threshold (GiB).** Minimum remaining cluster volume space, including Serverless v2.

* Default: `100`
* Min: `1`
* Shown when: `{"cloudwatch_alarms_creation_enabled":true,"engine":"aurora-mysql"}`

**cloudwatch\_alarm\_volume\_bytes\_used\_threshold\_tib** `number`

**Used storage alarm threshold (TiB).** Maximum cluster volume usage, including Serverless v2. Tune below the storage limit supported by your engine version.

* Default: `115`
* Min: `1`
* Shown when: `{"cloudwatch_alarms_creation_enabled":true,"engine":"aurora-postgresql"}`

**cloudwatch\_alarm\_read\_iops\_threshold** `number`

**Read IOPS alarm threshold.** Maximum across cluster instances, 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.** Maximum across cluster instances, 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.** Storage uses at least five minutes; I/O uses at least one minute.

* 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}`

### Global database

**global\_cluster\_creation\_enabled** `boolean`

**Global cluster creation.**

* Default: `false`
* Immutable after creation

**global\_cluster\_identifier** `string`

**Global cluster identifier.** Global cluster identifier. Set this to create a new global cluster or join an existing global cluster.

* Immutable after creation

**source\_region** `string`

**Source region.** Source region for cross-region replication in a global database.

* Immutable after creation

**global\_write\_forwarding\_enabled** `boolean`

**Global write forwarding.**

* Default: `false`
* Shown when: `{"engine":"aurora-postgresql"}`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.