Required 1

Set these to use the module.

• identifierstring, no defaultThe name of the RDS instance

Optional 110

• allocated_storagenumber, default nullThe allocated storage in gigabytes
• allow_major_version_upgradebool, default falseIndicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible
• apply_immediatelybool, default falseSpecifies whether any database modifications are applied immediately, or during the next maintenance window
• auto_minor_version_upgradebool, default trueIndicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window
• availability_zonestring, default nullThe Availability Zone of the RDS instance
• backup_retention_periodnumber, default nullThe days to retain backups for
• backup_windowstring, default nullThe daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window
• blue_green_updateobject({...}), default nullEnables low-downtime updates using RDS Blue/Green deployments.
• ca_cert_identifierstring, default nullSpecifies the identifier of the CA certificate for the DB instance
• character_set_namestring, default nullThe character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS and Collations and Character Sets for Microsoft SQL Server for more information. This can only be set on creation
• cloudwatch_log_group_classstring, default nullSpecified the log class of the log group. Possible values are: STANDARD or INFREQUENT_ACCESS
• cloudwatch_log_group_kms_key_idstring, default nullThe ARN of the KMS Key to use when encrypting log data
• cloudwatch_log_group_retention_in_daysnumber, default 7The number of days to retain CloudWatch logs for the DB instance
• cloudwatch_log_group_skip_destroybool, default nullSet to true if you do not wish the log group (and any logs it may contain) to be deleted at destroy time, and instead just remove the log group from the Terraform state
• cloudwatch_log_group_tagsmap(string), default {}Additional tags for the CloudWatch log group(s)
• copy_tags_to_snapshotbool, default trueOn delete, copy all Instance tags to the final snapshot
• create_cloudwatch_log_groupbool, default falseDetermines whether a CloudWatch log group is created for each enabled_cloudwatch_logs_exports
• create_db_instancebool, default trueWhether to create a database instance
• create_db_option_groupbool, default trueCreate a database option group
• create_db_parameter_groupbool, default trueWhether to create a database parameter group
• create_db_subnet_groupbool, default falseWhether to create a database subnet group
• create_monitoring_rolebool, default falseCreate IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs
• custom_iam_instance_profilestring, default nullRDS custom iam instance profile
• customer_owned_ip_enabledbool, default nullIndicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance
• database_insights_modestring, default nullThe mode of Database Insights that is enabled for the instance. Valid values: standard, advanced
• db_instance_role_associationsmap(string), default {}A map of DB instance supported feature name to role association ARNs.
• db_instance_tagsmap(string), default {}Additional tags for the DB instance
• db_namestring, default nullThe DB name to create. If omitted, no database is created initially
• db_option_group_tagsmap(string), default {}Additional tags for the DB option group
• db_parameter_group_tagsmap(string), default {}Additional tags for the DB parameter group
• db_subnet_group_descriptionstring, default nullDescription of the DB subnet group to create
• db_subnet_group_namestring, default nullName of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC
• db_subnet_group_tagsmap(string), default {}Additional tags for the DB subnet group
• db_subnet_group_use_name_prefixbool, default trueDetermines whether to use subnet_group_name as is or create a unique name beginning with the subnet_group_name as the prefix
• dedicated_log_volumebool, default falseUse a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS.
• delete_automated_backupsbool, default trueSpecifies whether to remove automated backups immediately after the DB instance is deleted
• deletion_protectionbool, default falseThe database can't be deleted when this value is set to true
• domainstring, default nullThe ID of the Directory Service Active Directory domain to create the instance in
• domain_auth_secret_arnstring, default null(Optional, but required if domain_fqdn is provided) The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with domain and domain_iam_role_name.
• domain_dns_ipslist(string), default null(Optional, but required if domain_fqdn is provided) The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with domain and domain_iam_role_name.
• domain_fqdnstring, default nullThe fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with domain and domain_iam_role_name.
• domain_iam_role_namestring, default null(Required if domain is provided) The name of the IAM role to be used when making API calls to the Directory Service
• domain_oustring, default null(Optional, but required if domain_fqdn is provided) The self managed Active Directory organizational unit for your DB instance to join. Conflicts with domain and domain_iam_role_name.
• enabled_cloudwatch_logs_exportslist(string), default []List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL)
• enginestring, default nullThe database engine to use
• engine_lifecycle_supportstring, default nullThe life cycle type for this DB instance. This setting applies only to RDS for MySQL and RDS for PostgreSQL. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support.
• engine_versionstring, default nullThe engine version to use
• familystring, default nullThe family of the DB parameter group
• final_snapshot_identifier_prefixstring, default "final"The name which is prefixed to the final snapshot on cluster destroy
• iam_database_authentication_enabledbool, default falseSpecifies whether or not the mappings of AWS Identity and Access Management (IAM) accounts to database accounts are enabled
• instance_classstring, default nullThe instance type of the RDS instance
• instance_use_identifier_prefixbool, default falseDetermines whether to use identifier as is or create a unique identifier beginning with identifier as the specified prefix
• iopsnumber, default nullThe amount of provisioned IOPS. Setting this implies a storage_type of 'io1' or gp3. See notes for limitations regarding this variable for gp3
• kms_key_idstring, default nullThe ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used. Be sure to use the full ARN, not a key alias.
• license_modelstring, default nullLicense model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1
• maintenance_windowstring, default nullThe window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00'
• major_engine_versionstring, default nullSpecifies the major version of the engine that this option group should be associated with
• manage_master_user_passwordbool, default trueSet to true to allow RDS to manage the master user password in Secrets Manager
• manage_master_user_password_rotationbool, default falseWhether to manage the master user password rotation. By default, false on creation, rotation is managed by RDS. There is not currently a way to disable this on initial creation even when set to false. Setting this value to false after previously having been set to true will disable automatic rotation.
• master_user_password_rotate_immediatelybool, default nullSpecifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
• master_user_password_rotation_automatically_after_daysnumber, default nullSpecifies the number of days between automatic scheduled rotations of the secret. Either automatically_after_days or schedule_expression must be specified.
• master_user_password_rotation_durationstring, default nullThe length of the rotation window in hours. For example, 3h for a three hour window.
• master_user_password_rotation_schedule_expressionstring, default nullA cron() or rate() expression that defines the schedule for rotating your secret. Either automatically_after_days or schedule_expression must be specified.
• master_user_secret_kms_key_idstring, default null The key ARN, key ID, alias ARN or alias name for the KMS key to encrypt the master user password secret in Secrets Manager. If not specified, the default KMS key for your Amazon Web Services account is used.
• max_allocated_storagenumber, default 0Specifies the value for Storage Autoscaling
• monitoring_intervalnumber, default 0The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60
• monitoring_role_arnstring, default nullThe ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero
• monitoring_role_descriptionstring, default nullDescription of the monitoring IAM role
• monitoring_role_namestring, default "rds-monitoring-role"Name of the IAM role which will be created when create_monitoring_role is enabled
• monitoring_role_permissions_boundarystring, default nullARN of the policy that is used to set the permissions boundary for the monitoring IAM role
• monitoring_role_use_name_prefixbool, default falseDetermines whether to use monitoring_role_name as is or create a unique identifier beginning with monitoring_role_name as the specified prefix
• multi_azbool, default falseSpecifies if the RDS instance is multi-AZ
• nchar_character_set_namestring, default nullThe national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed.
• network_typestring, default nullThe type of network stack to use
• option_group_descriptionstring, default nullThe description of the option group
• option_group_namestring, default nullName of the option group
• option_group_skip_destroybool, default nullSet to true if you do not wish the option group to be deleted at destroy time, and instead just remove the option group from the Terraform state
• option_group_timeoutsobject({...}), default nullDefine maximum timeout for deletion of aws_db_option_group resource
• option_group_use_name_prefixbool, default trueDetermines whether to use option_group_name as is or create a unique name beginning with the option_group_name as the prefix
• optionslist({...}), default nullA list of Options to apply
• parameter_group_descriptionstring, default nullDescription of the DB parameter group to create
• parameter_group_namestring, default nullName of the DB parameter group to associate or create
• parameter_group_skip_destroybool, default nullSet to true if you do not wish the parameter group to be deleted at destroy time, and instead just remove the parameter group from the Terraform state
• parameter_group_use_name_prefixbool, default trueDetermines whether to use parameter_group_name as is or create a unique name beginning with the parameter_group_name as the prefix
• parameterslist({...}), default nullA list of DB parameters (map) to apply
• password_wostring, default nullWrite-Only required unless manage_master_user_password is set to true, snapshot_identifier, or replicate_source_db is provided). Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file
• password_wo_versionnumber, default nullUsed together with password_wo to trigger an update. Increment this value when an update to password_wo is required.
• performance_insights_enabledbool, default falseSpecifies whether Performance Insights are enabled
• performance_insights_kms_key_idstring, default nullThe ARN for the KMS key to encrypt Performance Insights data
• performance_insights_retention_periodnumber, default 7The amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31
• portstring, default nullThe port on which the DB accepts connections
• publicly_accessiblebool, default falseBool to control if instance is publicly accessible
• putin_khuylobool, default trueDo you agree that Putin doesn't respect Ukrainian sovereignty and territorial integrity? More info: https://en.wikipedia.org/wiki/Putin_khuylo!
• regionstring, default nullRegion where this resource will be managed. Defaults to the Region set in the provider configuration
• replica_modestring, default nullSpecifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified
• replicate_source_dbstring, default nullSpecifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate
• restore_to_point_in_timeobject({...}), default nullRestore to a point in time (MySQL is NOT supported)
• s3_importobject({...}), default nullRestore from a Percona Xtrabackup in S3 (only MySQL is supported)
• skip_final_snapshotbool, default falseDetermines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted
• snapshot_identifierstring, default nullSpecifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05
• storage_encryptedbool, default trueSpecifies whether the DB instance is encrypted
• storage_throughputnumber, default nullStorage throughput value for the DB instance. See notes for limitations regarding this variable for gp3
• storage_typestring, default nullOne of 'standard' (magnetic), 'gp2' (general purpose SSD), 'gp3' (new generation of general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'gp2' if not. If you specify 'io1' or 'gp3' , you must also include a value for the 'iops' parameter
• subnet_idslist(string), default []A list of VPC subnet IDs
• tagsmap(string), default {}A mapping of tags to assign to all resources
• timeoutsobject({...}), default nullUpdated Terraform resource management timeouts. Applies to aws_db_instance in particular to permit resource management times
• timezonestring, default nullTime zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information
• upgrade_storage_configbool, default nullWhether to upgrade the storage file system configuration on the read replica. Can only be set with replicate_source_db.
• usernamestring, default nullUsername for the master DB user
• vpc_security_group_idslist(string), default []List of VPC security groups to associate