Outputs

Instance

db_instance_address

string

The hostname of the RDS instance. Use this for DNS-based connections.

db_instance_arn

string

The ARN of the RDS instance.

db_instance_availability_zone

string

The Availability Zone in which the RDS instance is running.

db_instance_endpoint

string

The connection endpoint in address:port format. Use this value directly in application connection strings.

db_instance_engine

string

The database engine of the RDS instance (e.g. mysql, postgres).

db_instance_engine_version_actual

string

The running version of the database engine. This may differ from the requested engine_version if minor version auto-upgrades are enabled.

db_instance_hosted_zone_id

string

The canonical hosted zone ID of the DB instance. Use this in a Route 53 Alias record to route traffic to the instance.

db_instance_identifier

string

The RDS instance identifier. When instance_use_identifier_prefix is true, this will be the generated unique identifier.

db_instance_resource_id

string

The RDS Resource ID of this instance. This is a stable identifier used in CloudWatch metrics and IAM policies.

db_instance_status

string

The current status of the RDS instance (e.g. available, modifying, backing-up).

db_instance_name

string

The name of the database created on the instance, as specified by db_name.

db_instance_username

string

The master username for the database. This output is marked sensitive.

db_instance_port

number

The port on which the database instance is accepting connections.

db_instance_ca_cert_identifier

string

The identifier of the CA certificate in use by the DB instance.

db_instance_upgrade_rollout_order

string

The order in which the instance is upgraded during a multi-instance upgrade. Possible values: first, second, last.

Authentication

db_instance_master_user_secret_arn

string

The ARN of the master user secret in AWS Secrets Manager. Only available when manage_master_user_password is set to true.

db_instance_secretsmanager_secret_rotation_enabled

bool

Specifies whether automatic rotation is enabled for the master user password secret in Secrets Manager.

Active Directory

db_instance_domain

string

The ID of the Directory Service Active Directory domain the instance is joined to.

db_instance_domain_auth_secret_arn

string

The ARN for the Secrets Manager secret with the self-managed Active Directory credentials for the user joining the domain.

db_instance_domain_dns_ips

list(string)

The IPv4 DNS IP addresses of the primary and secondary self-managed Active Directory domain controllers.

db_instance_domain_fqdn

string

The fully qualified domain name (FQDN) of the self-managed Active Directory domain.

db_instance_domain_iam_role_name

string

The name of the IAM role used when making API calls to the Directory Service.

db_instance_domain_ou

string

The self-managed Active Directory organizational unit the DB instance has joined.

SQL Server

db_listener_endpoint

object

The listener connection endpoint for SQL Server Always On. Contains address, hosted_zone_id, and port attributes. Only populated for SQL Server instances with Always On enabled.

Subnet Group

db_subnet_group_id

string

The name (ID) of the DB subnet group.

db_subnet_group_arn

string

The ARN of the DB subnet group.

Parameter Group

db_parameter_group_id

string

The name (ID) of the DB parameter group.

db_parameter_group_arn

string

The ARN of the DB parameter group.

Option Group

db_option_group_id

string

The name (ID) of the DB option group.

db_option_group_arn

string

The ARN of the DB option group.

Monitoring

enhanced_monitoring_iam_role_arn

string

The ARN of the IAM role created for Enhanced Monitoring. Only populated when create_monitoring_role is true.

enhanced_monitoring_iam_role_name

string

The name of the IAM role created for Enhanced Monitoring. Only populated when create_monitoring_role is true.

CloudWatch

db_instance_cloudwatch_log_groups

map(object)

A map of CloudWatch log groups created for the DB instance, keyed by log type (e.g. general, slowquery, postgresql). Each value contains the full aws_cloudwatch_log_group resource attributes. Only populated when create_cloudwatch_log_group is true.

Role Association

db_instance_role_associations

map(object)

A map of DB instance role association resources, keyed by feature name. Each value contains the full aws_db_instance_role_association resource attributes including id (formatted as db_instance_identifier,role_arn).

Root Module

Submodules

Build docs developers (and LLMs) love