RDS
Terraform module to create AWS RDS resources
Inputs
40 / 111
identifierrequiredstringThe name of the RDS instance
allocated_storageoptionalnumberThe allocated storage in gigabytes
nullallow_major_version_upgradeoptionalboolIndicates 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
falseapply_immediatelyoptionalboolSpecifies whether any database modifications are applied immediately, or during the next maintenance window
falseauto_minor_version_upgradeoptionalboolIndicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window
trueavailability_zoneoptionalstringThe Availability Zone of the RDS instance
nullbackup_retention_periodoptionalnumberThe days to retain backups for
nullbackup_windowoptionalstringThe 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
nullblue_green_updateoptionalobject({ enabled = optional(bool) })Enables low-downtime updates using RDS Blue/Green deployments.
nullca_cert_identifieroptionalstringSpecifies the identifier of the CA certificate for the DB instance
nullcharacter_set_nameoptionalstringThe 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
nullcloudwatch_log_group_classoptionalstringSpecified the log class of the log group. Possible values are: STANDARD or INFREQUENT_ACCESS
nullcloudwatch_log_group_kms_key_idoptionalstringThe ARN of the KMS Key to use when encrypting log data
nullcloudwatch_log_group_retention_in_daysoptionalnumberThe number of days to retain CloudWatch logs for the DB instance
7cloudwatch_log_group_skip_destroyoptionalboolSet 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
nullcloudwatch_log_group_tagsoptionalmap(string)Additional tags for the CloudWatch log group(s)
{}copy_tags_to_snapshotoptionalboolOn delete, copy all Instance tags to the final snapshot
truecreate_cloudwatch_log_groupoptionalboolDetermines whether a CloudWatch log group is created for each `enabled_cloudwatch_logs_exports`
falsecreate_db_instanceoptionalboolWhether to create a database instance
truecreate_db_option_groupoptionalboolCreate a database option group
truecreate_db_parameter_groupoptionalboolWhether to create a database parameter group
truecreate_db_subnet_groupoptionalboolWhether to create a database subnet group
falsecreate_monitoring_roleoptionalboolCreate IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs
falsecustom_iam_instance_profileoptionalstringRDS custom iam instance profile
nullcustomer_owned_ip_enabledoptionalboolIndicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance
nulldatabase_insights_modeoptionalstringThe mode of Database Insights that is enabled for the instance. Valid values: standard, advanced
nulldb_instance_role_associationsoptionalmap(string)A map of DB instance supported feature name to role association ARNs.
{}db_instance_tagsoptionalmap(string)Additional tags for the DB instance
{}db_nameoptionalstringThe DB name to create. If omitted, no database is created initially
nulldb_option_group_tagsoptionalmap(string)Additional tags for the DB option group
{}db_parameter_group_tagsoptionalmap(string)Additional tags for the DB parameter group
{}db_subnet_group_descriptionoptionalstringDescription of the DB subnet group to create
nulldb_subnet_group_nameoptionalstringName 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
nulldb_subnet_group_tagsoptionalmap(string)Additional tags for the DB subnet group
{}db_subnet_group_use_name_prefixoptionalboolDetermines whether to use `subnet_group_name` as is or create a unique name beginning with the `subnet_group_name` as the prefix
truededicated_log_volumeoptionalboolUse a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS.
falsedelete_automated_backupsoptionalboolSpecifies whether to remove automated backups immediately after the DB instance is deleted
truedeletion_protectionoptionalboolThe database can't be deleted when this value is set to true
falsedomainoptionalstringThe ID of the Directory Service Active Directory domain to create the instance in
nulldomain_auth_secret_arnoptionalstring(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.
null1 of 111 must be supplied; the rest have defaults. Showing 40, so the site stays a static download — the remaining 71 are in the source.
Outputs
34
db_instance_addressThe address of the RDS instance
db_instance_arnThe ARN of the RDS instance
db_instance_availability_zoneThe availability zone of the RDS instance
db_instance_ca_cert_identifierSpecifies the identifier of the CA certificate for the DB instance
db_instance_cloudwatch_log_groupsMap of CloudWatch log groups created and their attributes
db_instance_domainThe ID of the Directory Service Active Directory domain the instance is joined to
db_instance_domain_auth_secret_arnThe ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain
db_instance_domain_dns_ipsThe IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers
db_instance_domain_fqdnThe fully qualified domain name (FQDN) of an self managed Active Directory domain
db_instance_domain_iam_role_nameThe name of the IAM role to be used when making API calls to the Directory Service
db_instance_domain_ouThe self managed Active Directory organizational unit for your DB instance to join
db_instance_endpointThe connection endpoint
db_instance_engineThe database engine
db_instance_engine_version_actualThe running version of the database
db_instance_hosted_zone_idThe canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record)
db_instance_identifierThe RDS instance identifier
db_instance_master_user_secret_arnThe ARN of the master user secret (Only available when manage_master_user_password is set to true)
db_instance_nameThe database name
db_instance_portThe database port
db_instance_resource_idThe RDS Resource ID of this instance
db_instance_role_associationsA map of DB Instance Identifiers and IAM Role ARNs separated by a comma
db_instance_secretsmanager_secret_rotation_enabledSpecifies whether automatic rotation is enabled for the secret
db_instance_statusThe RDS instance status
db_instance_upgrade_rollout_orderOrder in which the instances are upgraded (first, second, last)
db_instance_usernameThe master username for the database
db_listener_endpointSpecifies the listener connection endpoint for SQL Server Always On
db_option_group_arnThe ARN of the db option group
db_option_group_idThe db option group id
db_parameter_group_arnThe ARN of the db parameter group
db_parameter_group_idThe db parameter group id
db_subnet_group_arnThe ARN of the db subnet group
db_subnet_group_idThe db subnet group name
enhanced_monitoring_iam_role_arnThe Amazon Resource Name (ARN) specifying the monitoring role
enhanced_monitoring_iam_role_nameThe name of the monitoring role
What the agent wires into the next module. An edge on the architecture diagram is one of these consumed by something else.