{"id":21202524,"url":"https://github.com/infrablocks/terraform-aws-rds-postgres","last_synced_at":"2025-10-09T07:35:04.397Z","repository":{"id":22496383,"uuid":"94785209","full_name":"infrablocks/terraform-aws-rds-postgres","owner":"infrablocks","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-29T00:52:15.000Z","size":562,"stargazers_count":9,"open_issues_count":8,"forks_count":9,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-07-10T10:47:57.131Z","etag":null,"topics":["aws","infrastructure","postgres","rds","terraform","terraform-modules"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/infrablocks.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"security_group.tf","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-06-19T14:23:05.000Z","updated_at":"2025-05-29T00:27:04.000Z","dependencies_parsed_at":"2023-02-14T14:31:02.881Z","dependency_job_id":"985f829f-a8fa-48b0-ae43-3b7bd44bdfba","html_url":"https://github.com/infrablocks/terraform-aws-rds-postgres","commit_stats":null,"previous_names":[],"tags_count":66,"template":false,"template_full_name":null,"purl":"pkg:github/infrablocks/terraform-aws-rds-postgres","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fterraform-aws-rds-postgres","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fterraform-aws-rds-postgres/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fterraform-aws-rds-postgres/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fterraform-aws-rds-postgres/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/infrablocks","download_url":"https://codeload.github.com/infrablocks/terraform-aws-rds-postgres/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fterraform-aws-rds-postgres/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000960,"owners_count":26082973,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","infrastructure","postgres","rds","terraform","terraform-modules"],"created_at":"2024-11-20T20:16:42.139Z","updated_at":"2025-10-09T07:35:04.381Z","avatar_url":"https://github.com/infrablocks.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"Terraform AWS RDS Postgres\n==========================\n\n[![CircleCI](https://circleci.com/gh/infrablocks/terraform-aws-rds-postgres.svg?style=svg)](https://circleci.com/gh/infrablocks/terraform-aws-rds)\n\nA Terraform module for deploying an RDS PostreSQL instance in AWS.\n\nThe AWS RDS requires:\n\n* An existing VPC\n\nThe RDS consists of:\n\n* security groups\n* subnet groups\n\nUsage\n-----\n\nTo use the module, include something like the following in your Terraform\nconfiguration:\n\n```hcl-terraform\nmodule \"database\" {\n  source  = \"infrablocks/rds-postgres/aws\"\n  version = \"0.1.8\"\n\n  region = \"eu-west-2\"\n  vpc_id = \"vpc-b197da6b\"\n  subnet_ids = [\"subnet-7cd8832a\", \"subnet-0199db7c\"]\n  allowed_cidrs = [\"10.0.0.0/16\"]\n\n  component             = \"identity-server\"\n  deployment_identifier = \"2f3eddcb\"\n\n  database_instance_class = \"db.t2.medium\"\n  database_version        = \"9.6.8\"\n\n  database_name            = \"identity\"\n  database_master_user     = \"admin\"\n  database_master_password = \"1D$£#J!LKeE£(9d9\"\n}\n```\n\nAs mentioned above, the database deploys into an existing base network:\n\n* [AWS Base Networking](https://github.com/infrablocks/terraform-aws-base-networking)\n\nSee the\n[Terraform registry entry](https://registry.terraform.io/modules/infrablocks/rds-postgres/aws/latest)\nfor more details.\n\n### Inputs\n\n| Name                            | Description                                                                                                                                                                                                                                                                       |        Default        | Required |\n|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------:|:--------:|\n| region                          | The region into which to deploy the database                                                                                                                                                                                                                                      |           -           |   yes    |\n| vpc_id                          | The ID of the VPC into which to deploy the database                                                                                                                                                                                                                               |           -           |   yes    |\n| component                       | The component this database will serve                                                                                                                                                                                                                                            |           -           |   yes    |\n| deployment_identifier           | An identifier for this instantiation                                                                                                                                                                                                                                              |           -           |   yes    |\n| allowed_cidrs                   | The CIDR of the private network allowed access to the ELB                                                                                                                                                                                                                         |           -           |   yes    |\n| subnet_ids                      | The IDs of the subnets to deploy the database into                                                                                                                                                                                                                                |           -           |   yes    |\n| database_instance_class         | The instance type of the RDS instance.                                                                                                                                                                                                                                            |           -           |   yes    |\n| database_version                | The database version. If omitted, it lets Amazon decide.                                                                                                                                                                                                                          |           -           |    no    |\n| database_name                   | The DB name to create. If omitted, no database is created initially.                                                                                                                                                                                                              |           -           |   yes    |\n| database_master_user_password   | The password for the master database user.                                                                                                                                                                                                                                        |           -           |   yes    |\n| database_master_user            | The username for the master database user.                                                                                                                                                                                                                                        |           -           |   yes    |\n| use_multiple_availability_zones | Whether to create a multi-availability zone database (\"yes\" or \"no\").                                                                                                                                                                                                             |         \"no\"          |   yes    |\n| use_encrypted_storage           | Whether or not to use encrypted storage for the database (\"yes\" or \"no\").                                                                                                                                                                                                         |         \"no\"          |   yes    |\n| snapshot_identifier             | The identifier of the snapshot to use to create the database.                                                                                                                                                                                                                     |           -           |    no    |\n| backup_retention_period         | The number of days to retain database backups.                                                                                                                                                                                                                                    |           7           |   yes    |\n| backup_window                   | The time window in which backups should take place.                                                                                                                                                                                                                               |     \"01:00-03:00\"     |   yes    |\n| maintenance_window              | The time window in which maintenance should take place.                                                                                                                                                                                                                           | \"mon:03:01-mon:05:00\" |   yes    |\n| parameter_group_name            | Name of the DB parameter group to associate.                                                                                                                                                                                                                                      |         null          |    no    |\n| skip_final_snapshot             | Whether or not to create a snapshot on DB deletion.                                                                                                                                                                                                                               |         true          |    no    |\n| include_self_ingress_rule       | Whether or not to add a self-referencing ingress rule on the security group                                                                                                                                                                                                       |         \"no\"          |    no    |\n| allow_major_version_upgrade     | Whether or not to allow major version upgrades                                                                                                                                                                                                                                    |         \"no\"          |    no    |\n| auto_minor_version_upgrade      | Whether or not to enable auto minor version upgrades                                                                                                                                                                                                                              |         \"yes\"         |    no    |\n| storage_type                    | The storage type of the RDS instance (\"standard\" or \"gp2\")                                                                                                                                                                                                                        |      \"standard\"       |    no    |\n| performance_insights_enabled    | Whether or not performance insights are enabled                                                                                                                                                                                                                                   |         \"no\"          |    no    |\n| max_allocated_storage           | When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. See the [terraform documentation](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_instance#storage-autoscaling) for more information. |           0           |    no    |\n\n### Outputs\n\n| Name                    | Description                    |\n|-------------------------|--------------------------------|\n| postgres_database_port  | The database port              |\n| postgres_database_host  | The database host              |\n| postgres_database_name  | The database name              |\n| postgres_database_sg_id | The database security group id |\n\n### Compatibility\n\nThis module is compatible with Terraform versions greater than or equal to\nTerraform 1.0.\n\nDevelopment\n-----------\n\n### Machine Requirements\n\nIn order for the build to run correctly, a few tools will need to be installed\non your development machine:\n\n* Ruby (3.1.1)\n* Bundler\n* git\n* git-crypt\n* gnupg\n* direnv\n* aws-vault\n\n#### Mac OS X Setup\n\nInstalling the required tools is best managed by [homebrew](http://brew.sh).\n\nTo install homebrew:\n\n```\nruby -e \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)\"\n```\n\nThen, to install the required tools:\n\n```\n# ruby\nbrew install rbenv\nbrew install ruby-build\necho 'eval \"$(rbenv init - bash)\"' \u003e\u003e ~/.bash_profile\necho 'eval \"$(rbenv init - zsh)\"' \u003e\u003e ~/.zshrc\neval \"$(rbenv init -)\"\nrbenv install 3.1.1\nrbenv rehash\nrbenv local 3.1.1\ngem install bundler\n\n# git, git-crypt, gnupg\nbrew install git\nbrew install git-crypt\nbrew install gnupg\n\n# aws-vault\nbrew cask install\n\n# direnv\nbrew install direnv\necho \"$(direnv hook bash)\" \u003e\u003e ~/.bash_profile\necho \"$(direnv hook zsh)\" \u003e\u003e ~/.zshrc\neval \"$(direnv hook $SHELL)\"\n\ndirenv allow \u003crepository-directory\u003e\n```\n\n### Running the build\n\nRunning the build requires an AWS account and AWS credentials. You are free to\nconfigure credentials however you like as long as an access key ID and secret\naccess key are available. These instructions utilise\n[aws-vault](https://github.com/99designs/aws-vault) which makes credential\nmanagement easy and secure.\n\nTo provision module infrastructure, run tests and then destroy that\ninfrastructure, execute:\n\n```bash\naws-vault exec \u003cprofile\u003e -- ./go\n```\n\nTo provision the module prerequisites:\n\n```bash\naws-vault exec \u003cprofile\u003e -- ./go deployment:prerequisites:provision[\u003cdeployment_identifier\u003e]\n```\n\nTo provision the module contents:\n\n```bash\naws-vault exec \u003cprofile\u003e -- ./go deployment:root:provision[\u003cdeployment_identifier\u003e]\n```\n\nTo destroy the module contents:\n\n```bash\naws-vault exec \u003cprofile\u003e -- ./go deployment:root:destroy[\u003cdeployment_identifier\u003e]\n```\n\nTo destroy the module prerequisites:\n\n```bash\naws-vault exec \u003cprofile\u003e -- ./go deployment:prerequisites:destroy[\u003cdeployment_identifier\u003e]\n```\n\nConfiguration parameters can be overridden via environment variables:\n\n```bash\nDEPLOYMENT_IDENTIFIER=testing aws-vault exec \u003cprofile\u003e -- ./go\n```\n\nWhen a deployment identifier is provided via an environment variable,\ninfrastructure will not be destroyed at the end of test execution. This can\nbe useful during development to avoid lengthy provision and destroy cycles.\n\nBy default, providers will be downloaded for each terraform execution. To\ncache providers between calls:\n\n```bash\nTF_PLUGIN_CACHE_DIR=\"$HOME/.terraform.d/plugin-cache\" aws-vault exec \u003cprofile\u003e -- ./go\n```\n\n### Common Tasks\n\n#### Generating an SSH key pair\n\nTo generate an SSH key pair:\n\n```\nssh-keygen -m PEM -t rsa -b 4096 -C integration-test@example.com -N '' -f config/secrets/keys/bastion/ssh\n```\n\n#### Generating a self-signed certificate\n\nTo generate a self signed certificate:\n\n```\nopenssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365\n```\n\nTo decrypt the resulting key:\n\n```\nopenssl rsa -in key.pem -out ssl.key\n```\n\n#### Add a git-crypt user\n\nTo adding a user to git-crypt using their GPG key:\n\n```\ngpg --import ~/path/xxxx.pub\ngit-crypt add-gpg-user --trusted GPG-USER-ID\n\n```\n\n#### Managing CircleCI keys\n\nTo encrypt a GPG key for use by CircleCI:\n\n```bash\nopenssl aes-256-cbc \\\n  -e \\\n  -md sha1 \\\n  -in ./config/secrets/ci/gpg.private \\\n  -out ./.circleci/gpg.private.enc \\\n  -k \"\u003cpassphrase\u003e\"\n```\n\nTo check decryption is working correctly:\n\n```bash\nopenssl aes-256-cbc \\\n  -d \\\n  -md sha1 \\\n  -in ./.circleci/gpg.private.enc \\\n  -k \"\u003cpassphrase\u003e\"\n```\n\nContributing\n------------\n\nBug reports and pull requests are welcome on GitHub at\nhttps://github.com/infrablocks/terraform-aws-rds-postgres.\nThis project is intended to be a safe, welcoming space for collaboration, and\ncontributors are expected to adhere to the\n[Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\nLicense\n-------\n\nThe library is available as open source under the terms of the\n[MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfrablocks%2Fterraform-aws-rds-postgres","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finfrablocks%2Fterraform-aws-rds-postgres","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfrablocks%2Fterraform-aws-rds-postgres/lists"}