allocated_storage |
The allocated storage in gigabytes |
number |
null |
no |
allow_major_version_upgrade |
Indicates 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 |
bool |
false |
no |
apply_immediately |
Specifies whether any database modifications are applied immediately, or during the next maintenance window |
bool |
false |
no |
auto_minor_version_upgrade |
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window |
bool |
true |
no |
availability_zone |
The Availability Zone of the RDS instance |
string |
null |
no |
backup_retention_period |
The days to retain backups for |
number |
null |
no |
backup_window |
The 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 |
string |
null |
no |
blue_green_update |
Enables low-downtime updates using RDS Blue/Green deployments. |
map(string) |
{} |
no |
ca_cert_identifier |
Specifies the identifier of the CA certificate for the DB instance |
string |
null |
no |
character_set_name |
The 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. |
string |
null |
no |
cloudwatch_log_group_class |
Specified the log class of the log group. Possible values are: STANDARD or INFREQUENT_ACCESS |
string |
null |
no |
cloudwatch_log_group_kms_key_id |
The ARN of the KMS Key to use when encrypting log data |
string |
null |
no |
cloudwatch_log_group_retention_in_days |
The number of days to retain CloudWatch logs for the DB instance |
number |
7 |
no |
cloudwatch_log_group_skip_destroy |
Set 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 |
bool |
null |
no |
copy_tags_to_snapshot |
On delete, copy all Instance tags to the final snapshot |
bool |
false |
no |
create |
Whether to create this resource or not? |
bool |
true |
no |
create_cloudwatch_log_group |
Determines whether a CloudWatch log group is created for each enabled_cloudwatch_logs_exports |
bool |
false |
no |
create_monitoring_role |
Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. |
bool |
false |
no |
custom_iam_instance_profile |
RDS custom iam instance profile |
string |
null |
no |
db_instance_tags |
A map of additional tags for the DB instance |
map(string) |
{} |
no |
db_name |
The DB name to create. If omitted, no database is created initially |
string |
null |
no |
db_subnet_group_name |
Name 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 |
string |
null |
no |
dedicated_log_volume |
Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. |
bool |
false |
no |
delete_automated_backups |
Specifies whether to remove automated backups immediately after the DB instance is deleted |
bool |
true |
no |
deletion_protection |
The database can't be deleted when this value is set to true. |
bool |
false |
no |
domain |
The ID of the Directory Service Active Directory domain to create the instance in |
string |
null |
no |
domain_auth_secret_arn |
(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. |
string |
null |
no |
domain_dns_ips |
(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. |
list(string) |
null |
no |
domain_fqdn |
The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with domain and domain_iam_role_name. |
string |
null |
no |
domain_iam_role_name |
(Required if domain is provided) The name of the IAM role to be used when making API calls to the Directory Service |
string |
null |
no |
domain_ou |
(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. |
string |
null |
no |
enabled_cloudwatch_logs_exports |
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). |
list(string) |
[] |
no |
engine |
The database engine to use |
string |
null |
no |
engine_lifecycle_support |
The 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 . |
string |
null |
no |
engine_version |
The engine version to use |
string |
null |
no |
final_snapshot_identifier_prefix |
The name which is prefixed to the final snapshot on cluster destroy |
string |
"final" |
no |
iam_database_authentication_enabled |
Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled |
bool |
false |
no |
identifier |
The name of the RDS instance |
string |
n/a |
yes |
instance_class |
The instance type of the RDS instance |
string |
null |
no |
iops |
The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' or gp3 . See notes for limitations regarding this variable for gp3 |
number |
null |
no |
kms_key_id |
The 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 |
string |
null |
no |
license_model |
License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 |
string |
null |
no |
maintenance_window |
The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' |
string |
null |
no |
manage_master_user_password |
Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided |
bool |
true |
no |
manage_master_user_password_rotation |
Whether to manage the master user password rotation. By default, false on creation, rotation is managed by RDS. Setting this value to false after previously having been set to true will disable automatic rotation. |
bool |
false |
no |
master_user_password_rotate_immediately |
Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. |
bool |
null |
no |
master_user_password_rotation_automatically_after_days |
Specifies the number of days between automatic scheduled rotations of the secret. Either automatically_after_days or schedule_expression must be specified. |
number |
null |
no |
master_user_password_rotation_duration |
The length of the rotation window in hours. For example, 3h for a three hour window. |
string |
null |
no |
master_user_password_rotation_schedule_expression |
A cron() or rate() expression that defines the schedule for rotating your secret. Either automatically_after_days or schedule_expression must be specified. |
string |
null |
no |
master_user_secret_kms_key_id |
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. |
string |
null |
no |
max_allocated_storage |
Specifies the value for Storage Autoscaling |
number |
0 |
no |
monitoring_interval |
The 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. |
number |
0 |
no |
monitoring_role_arn |
The 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. |
string |
null |
no |
monitoring_role_description |
Description of the monitoring IAM role |
string |
null |
no |
monitoring_role_name |
Name of the IAM role which will be created when create_monitoring_role is enabled. |
string |
"rds-monitoring-role" |
no |
monitoring_role_permissions_boundary |
ARN of the policy that is used to set the permissions boundary for the monitoring IAM role |
string |
null |
no |
monitoring_role_use_name_prefix |
Determines whether to use monitoring_role_name as is or create a unique identifier beginning with monitoring_role_name as the specified prefix |
bool |
false |
no |
multi_az |
Specifies if the RDS instance is multi-AZ |
bool |
false |
no |
nchar_character_set_name |
The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. |
string |
null |
no |
network_type |
The type of network stack |
string |
null |
no |
option_group_name |
Name of the DB option group to associate. |
string |
null |
no |
parameter_group_name |
Name of the DB parameter group to associate |
string |
null |
no |
password |
Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file |
string |
null |
no |
performance_insights_enabled |
Specifies whether Performance Insights are enabled |
bool |
false |
no |
performance_insights_kms_key_id |
The ARN for the KMS key to encrypt Performance Insights data. |
string |
null |
no |
performance_insights_retention_period |
The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). |
number |
7 |
no |
port |
The port on which the DB accepts connections |
string |
null |
no |
publicly_accessible |
Bool to control if instance is publicly accessible |
bool |
false |
no |
replica_mode |
Specifies 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 |
string |
null |
no |
replicate_source_db |
Specifies 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. |
string |
null |
no |
restore_to_point_in_time |
Restore to a point in time (MySQL is NOT supported) |
map(string) |
null |
no |
s3_import |
Restore from a Percona Xtrabackup in S3 (only MySQL is supported) |
map(string) |
null |
no |
skip_final_snapshot |
Determines 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 |
bool |
false |
no |
snapshot_identifier |
Specifies 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. |
string |
null |
no |
storage_encrypted |
Specifies whether the DB instance is encrypted |
bool |
true |
no |
storage_throughput |
Storage throughput value for the DB instance. This setting applies only to the gp3 storage type. See notes for limitations regarding this variable for gp3 |
number |
null |
no |
storage_type |
One 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 |
string |
null |
no |
tags |
A mapping of tags to assign to all resources |
map(string) |
{} |
no |
timeouts |
Updated Terraform resource management timeouts. Applies to aws_db_instance in particular to permit resource management times |
map(string) |
{} |
no |
timezone |
Time 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. |
string |
null |
no |
upgrade_storage_config |
Whether to upgrade the storage file system configuration on the read replica. Can only be set with replicate_source_db. |
bool |
null |
no |
use_identifier_prefix |
Determines whether to use identifier as is or create a unique identifier beginning with identifier as the specified prefix |
bool |
false |
no |
username |
Username for the master DB user |
string |
null |
no |
vpc_security_group_ids |
List of VPC security groups to associate |
list(string) |
[] |
no |