rds-db-proxy

cloudposse/rds-db-proxy/aws

Terraform Module HCL AWS

Terraform module to provision an Amazon RDS Proxy

Install
module "rds-db-proxy" {
source = "cloudposse/rds-db-proxy/aws"
version = "1.1.1"
}
⭐ Source on GitHub 📦 Registry page
README

Terraform module to provision an Amazon RDS Proxy for MySQL or Postgres. > [!TIP] > #### 👽 Use Atmos with Terraform > Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. > Works with Github Actions, Atlantis, or Spacelift. > > > Watch demo of using Atmos with Terraform > > Example of running atmos to manage infrastructure from our Quick Start tutorial. > Usage For a complete example, see examples/complete. For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test. ```hcl module "vpc" { source = "cloudposse/vpc/aws" # Cloud Posse recommends pinning every module to a specific version # version = "x.x.x" cidr_block = "172.16.0.0/16" context = module.this.context } module "subnets" { source = "clo

Inputs (38)
NameTypeDescriptionDefault
vpc_security_group_idsset(string)One or more VPC security group IDs to associate with the proxy required
vpc_subnet_idsset(string)One or more VPC subnet IDs to associate with the proxy required
authlist(object({ auth_scheme Configuration blocks with authorization mechanisms to connect to the associated required
additional_tag_mapmap(string)Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not add{}
require_tlsboolA Boolean parameter that specifies whether Transport Layer Security (TLS) encrypfalse
db_instance_identifierstringDB instance identifier. Either `db_instance_identifier` or `db_cluster_identifienull
proxy_update_timeoutstringProxy update timeout"30m"
engine_familystringThe kinds of databases that the proxy can connect to. This value determines whic"MYSQL"
regex_replace_charsstringTerraform regular expression (regex) string. Characters matching the regex will null
label_key_casestringControls the letter case of the `tags` keys (label names) for tags generated by null
label_value_casestringControls the letter case of ID elements (labels) as included in `id`, set as tagnull
descriptor_formatsanyDescribe additional descriptors to be output in the `descriptors` output map. Ma{}
enabledboolSet to false to prevent the module from creating any resourcesnull
namespacestringID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp'null
stagestringID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'bunull
connection_borrow_timeoutnumberThe number of seconds for a proxy to wait for a connection to become available i120
init_querystringOne or more SQL statements for the proxy to run when opening each new database cnull
max_connections_percentnumberThe maximum size of the connection pool for each target in a target group100
max_idle_connections_percentnumberControls how actively the proxy closes idle database connections in the connecti50
iam_role_attributeslist(string)Additional attributes to add to the ID of the IAM role that the proxy uses to acnull
attributeslist(string)ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`, []
id_length_limitnumberLimit `id` to this many characters (minimum 6). Set to `0` for unlimited length.null
idle_client_timeoutnumberThe number of seconds that a connection to the proxy can be inactive before the 1800
Outputs (13)
proxy_endpoint — Proxy endpoint
proxy_target_port — Port for the target RDS DB instance or Aurora DB cluster
proxy_target_target_arn — Amazon Resource Name (ARN) for the DB instance or DB cluster
proxy_target_tracked_cluster_id — DB Cluster identifier for the DB instance target. Not returned unless manually importing an `RDS_INS
proxy_target_type — Type of target. e.g. `RDS_INSTANCE` or `TRACKED_CLUSTER`
proxy_id — Proxy ID
proxy_target_endpoint — Hostname for the target RDS DB Instance. Only returned for `RDS_INSTANCE` type
proxy_target_id — Identifier of `db_proxy_name`, `target_group_name`, `target type` (e.g. `RDS_INSTANCE` or `TRACKED_C
proxy_target_rds_resource_id — Identifier representing the DB instance or DB cluster target
proxy_default_target_group_arn — The Amazon Resource Name (ARN) representing the default target group
proxy_default_target_group_name — The name of the default target group
proxy_iam_role_arn — The ARN of the IAM role that the proxy uses to access secrets in AWS Secrets Manager
proxy_arn — Proxy ARN
Resources (6)
aws_db_proxyaws_db_proxy_default_target_groupaws_db_proxy_targetaws_iam_policyaws_iam_roleaws_iam_role_policy_attachment
Details
FrameworkTerraform Module
LanguageHCL
Version1.1.1
Cloud AWS
★ Stars15
Forks15
Total downloads682.3k
Inputs38
Outputs13
Resources6
Examples1
LicenseApache-2.0
Namespacecloudposse
Updated