rds-proxy

clowdhaus/rds-proxy/aws

Terraform Module HCL AWS

Terraform module to create AWS RDS Proxy resources πŸ‡ΊπŸ‡¦

Install
module "rds-proxy" {
source = "clowdhaus/rds-proxy/aws"
version = "3.2.1"
}
plain text: /constructs/tfmod-clowdhaus-rds-proxy-aws/install.txt
⭐ Source on GitHub πŸ“¦ Registry page
README

AWS RDS Proxy Terraform module Terraform module which creates an AWS RDS Proxy and its supporting resources. Usage See examples directory for working examples to reference: ``hcl module "rds_proxy" { source = "terraform-aws-modules/rds-proxy/aws" name = "rds-proxy" iam_role_name = "rds-proxy-role" vpc_subnet_ids = ["subnet-30ef7b3c", "subnet-1ecda77b", "subnet-ca09ddbc"] vpc_security_group_ids = ["sg-f1d03a88"] endpoints = { read_write = { name = "read-write-endpoint" vpc_subnet_ids = ["subnet-30ef7b3c", "subnet-1ecda77b", "subnet-ca09ddbc"] vpc_security_group_ids = ["sg-f1d03a88"] }, read_only = { name = "read-only-endpoint" vpc_subnet_ids = ["subnet-30ef7b3c", "subnet-1ecda77b", "subnet-ca09ddbc"] vpc_security_group_ids = ["sg-f1d03a88"] target_role = "READ_ONLY" } } auth = { "superuser"

Inputs (39)
NameTypeDescriptionDefault
kms_key_arnslist(string)List of KMS Key ARNs to allow access to decrypt SecretsManager secrets[]
max_idle_connections_percentnumberControls how actively the proxy closes idle database connections in the connecti50
target_db_clusterboolDetermines whether DB cluster is targeted by proxyfalse
manage_log_groupboolDetermines whether Terraform will create/manage the CloudWatch log group or not.true
log_group_tagsmap(string)A map of tags to apply to the CloudWatch log group{}
max_connections_percentnumberThe maximum size of the connection pool for each target in a target group90
create_iam_policyboolDetermines whether an IAM policy is createdtrue
endpointsanyMap of DB proxy endpoints to create and their attributes (see `aws_db_proxy_endp{}
log_group_retention_in_daysnumberSpecifies the number of days you want to retain log events in the log group30
create_iam_roleboolDetermines whether an IAM role is createdtrue
vpc_subnet_idslist(string)One or more VPC subnet IDs to associate with the new proxy[]
init_querystringOne or more SQL statements for the proxy to run when opening each new database c""
tagsmap(string)A map of tags to add to all resources{}
engine_familystringThe kind of database engine that the proxy will connect to. Valid values are `MY""
idle_client_timeoutnumberThe number of seconds that a connection to the proxy can be inactive before the 1800
namestringThe identifier for the proxy. This name must be unique for all proxies owned by ""
connection_borrow_timeoutnumberThe number of seconds for a proxy to wait for a connection to become available inull
session_pinning_filterslist(string)Each item in the list represents a class of SQL operations that normally cause a[]
target_db_instanceboolDetermines whether DB instance is targeted by proxyfalse
db_cluster_identifierstringDB cluster identifier""
Outputs (19)
proxy_id β€” The ID for the proxy
proxy_arn β€” The Amazon Resource Name (ARN) for the proxy
proxy_target_id β€” Identifier of `db_proxy_name`, `target_group_name`, target type (e.g. `RDS_INSTANCE` or `TRACKED_CLU
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. Currently not returned by the RDS API
proxy_target_tracked_cluster_id β€” DB Cluster identifier for the DB Instance target. Not returned unless manually importing an RDS_INST
db_proxy_endpoints β€” Array containing the full resource object and attributes for all DB proxy endpoints created
proxy_target_rds_resource_id β€” Identifier representing the DB Instance or DB Cluster target
log_group_arn β€” The Amazon Resource Name (ARN) of the CloudWatch log group
iam_role_arn β€” The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets
proxy_default_target_group_arn β€” The Amazon Resource Name (ARN) for the default target group
proxy_default_target_group_name β€” The name of the default target group
proxy_target_endpoint β€” Hostname for the target RDS DB Instance. Only returned for `RDS_INSTANCE` type
log_group_name β€” The name of the CloudWatch log group
iam_role_name β€” IAM role name
proxy_endpoint β€” The endpoint that you can use to connect to the proxy
proxy_default_target_group_id β€” The ID for the default target group
proxy_target_type β€” Type of target. e.g. `RDS_INSTANCE` or `TRACKED_CLUSTER`
iam_role_unique_id β€” Stable and unique string identifying the IAM role
Resources (7)
aws_cloudwatch_log_groupaws_db_proxyaws_db_proxy_default_target_groupaws_db_proxy_endpointaws_db_proxy_targetaws_iam_roleaws_iam_role_policy
Details
FrameworkTerraform Module
LanguageHCL
Version3.2.1
Cloud AWS
β˜… Stars60
Forks68
Total downloads141.0k
Inputs39
Outputs19
Resources7
Examples4
LicenseApache-2.0
Namespaceclowdhaus
Updated