{"id":26575874,"url":"https://github.com/tomarv2/terraform-aws-parameterstore","last_synced_at":"2025-03-23T02:35:37.700Z","repository":{"id":42462066,"uuid":"339851182","full_name":"tomarv2/terraform-aws-parameterstore","owner":"tomarv2","description":"Terraform module for AWS SSM ParameterStore","archived":false,"fork":false,"pushed_at":"2023-04-04T04:57:09.000Z","size":52,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-22T15:49:55.041Z","etag":null,"topics":["aws","aws-parameter-store","terraform","terraform-module"],"latest_commit_sha":null,"homepage":"","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tomarv2.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-17T20:44:36.000Z","updated_at":"2022-03-03T21:39:56.000Z","dependencies_parsed_at":"2022-09-08T22:23:33.444Z","dependency_job_id":null,"html_url":"https://github.com/tomarv2/terraform-aws-parameterstore","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomarv2%2Fterraform-aws-parameterstore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomarv2%2Fterraform-aws-parameterstore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomarv2%2Fterraform-aws-parameterstore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomarv2%2Fterraform-aws-parameterstore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tomarv2","download_url":"https://codeload.github.com/tomarv2/terraform-aws-parameterstore/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245047996,"owners_count":20552431,"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","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","aws-parameter-store","terraform","terraform-module"],"created_at":"2025-03-23T02:35:37.201Z","updated_at":"2025-03-23T02:35:37.684Z","avatar_url":"https://github.com/tomarv2.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/tomarv2/terraform-aws-parameterstore/actions/workflows/pre-commit.yml\" alt=\"Pre Commit\"\u003e\n        \u003cimg src=\"https://github.com/tomarv2/terraform-aws-parameterstore/actions/workflows/pre-commit.yml/badge.svg?branch=main\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.apache.org/licenses/LICENSE-2.0\" alt=\"license\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/tomarv2/terraform-aws-parameterstore\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/tomarv2/terraform-aws-parameterstore/tags\" alt=\"GitHub tag\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/v/tag/tomarv2/terraform-aws-parameterstore\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/tomarv2/terraform-aws-parameterstore/pulse\" alt=\"Activity\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/commit-activity/m/tomarv2/terraform-aws-parameterstore\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://stackoverflow.com/users/6679867/tomarv2\" alt=\"Stack Exchange reputation\"\u003e\n        \u003cimg src=\"https://img.shields.io/stackexchange/stackoverflow/r/6679867\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://twitter.com/intent/follow?screen_name=varuntomar2019\" alt=\"follow on Twitter\"\u003e\n        \u003cimg src=\"https://img.shields.io/twitter/follow/varuntomar2019?style=social\u0026logo=twitter\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Terraform module for [AWS Parameterstore](https://registry.terraform.io/modules/tomarv2/parameterstore/aws/latest)\n\n### Versions\n\n- Module tested for Terraform 1.0.1.\n- AWS provider version [3.74](https://registry.terraform.io/providers/hashicorp/aws/latest)\n- `main` branch: Provider versions not pinned to keep up with Terraform releases\n- `tags` releases: Tags are pinned with versions (use \u003ca href=\"https://github.com/tomarv2/terraform-aws-parameterstore/tags\" alt=\"GitHub tag\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/v/tag/tomarv2/terraform-aws-parameterstore\" /\u003e\u003c/a\u003e in your releases)\n\n### Usage\n\n#### Option 1:\n\n```\nterrafrom init\nterraform plan -var='teamid=tryme' -var='prjid=project1'\nterraform apply -var='teamid=tryme' -var='prjid=project1'\nterraform destroy -var='teamid=tryme' -var='prjid=project1'\n```\n**Note:** With this option please take care of remote state storage\n\n#### Option 2:\n\n##### Recommended method (stores remote state in remote backend(S3,  Azure storage, or Google bucket) using `prjid` and `teamid` to create directory structure):\n\n- Create python 3.8+ virtual environment\n```\npython3 -m venv \u003cvenv name\u003e\n```\n\n- Install package:\n```\npip install tfremote --upgrade\n```\n\n- Set below environment variables:\n```\nexport TF_AWS_BUCKET=\u003cremote state bucket name\u003e\nexport TF_AWS_BUCKET_REGION=us-west-2\nexport TF_AWS_PROFILE=\u003cprofile from ~/.ws/credentials\u003e\n```\n\nor\n\n- Set below environment variables:\n```\nexport TF_AWS_BUCKET=\u003cremote state bucket name\u003e\nexport TF_AWS_BUCKET_REGION=us-west-2\nexport AWS_ACCESS_KEY_ID=\u003caws_access_key_id\u003e\nexport AWS_SECRET_ACCESS_KEY=\u003caws_secret_access_key\u003e\n```\n\n- Updated `examples` directory with required values.\n\n- Run and verify the output before deploying:\n```\ntf -c=aws plan -var='teamid=foo' -var='prjid=bar'\n```\n\n- Run below to deploy:\n```\ntf -c=aws apply -var='teamid=foo' -var='prjid=bar'\n```\n\n- Run below to destroy:\n```\ntf -c=aws destroy -var='teamid=foo' -var='prjid=bar'\n```\n\n**Note:** Read more on [tfremote](https://github.com/tomarv2/tfremote)\n##### SSM Parameterstore (String and SecuredString)\n```\nmodule \"ssm_parameter\" {\n  source = \"../\"\n\n  parameter_write = [\n    {\n      name        = \"/security/demo\"\n      value       = \"WORLD\"\n      type        = \"String\"\n      overwrite   = \"true\"\n      description = \"hello world string\"\n    },\n    {\n      name        = \"/security/demo-secured\"\n      value       = \"helloworld\"\n      type        = \"SecureString\"\n      overwrite   = \"true\"\n      description = \"hello world secured string\"\n    }\n  ]\n  kms_alias = \"alias/aws/ssm\"\n  #-----------------------------------------------\n  # Note: Do not change teamid and prjid once set.\n  teamid = var.teamid\n  prjid  = var.prjid\n}\n```\n\nPlease refer to examples directory [link](examples) for references.\n\n\u003c!-- BEGIN_TF_DOCS --\u003e\n## Requirements\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"requirement_terraform\"\u003e\u003c/a\u003e [terraform](#requirement\\_terraform) | \u003e= 1.0.1 |\n| \u003ca name=\"requirement_aws\"\u003e\u003c/a\u003e [aws](#requirement\\_aws) | ~\u003e 3.74 |\n\n## Providers\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"provider_aws\"\u003e\u003c/a\u003e [aws](#provider\\_aws) | ~\u003e 3.74 |\n\n## Modules\n\nNo modules.\n\n## Resources\n\n| Name | Type |\n|------|------|\n| [aws_ssm_parameter.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource |\n| [aws_ssm_parameter.ignore_value_changes](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource |\n\n## Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\n| \u003ca name=\"input_allowed_pattern\"\u003e\u003c/a\u003e [allowed\\_pattern](#input\\_allowed\\_pattern) | A regular expression used to validate the parameter value. | `string` | `\"\"` | no |\n| \u003ca name=\"input_custom_tags\"\u003e\u003c/a\u003e [custom\\_tags](#input\\_custom\\_tags) | Extra custom tags | `any` | `null` | no |\n| \u003ca name=\"input_ignore_value_changes\"\u003e\u003c/a\u003e [ignore\\_value\\_changes](#input\\_ignore\\_value\\_changes) | Whether to ignore future external changes in paramater values | `map` | `{}` | no |\n| \u003ca name=\"input_kms_alias\"\u003e\u003c/a\u003e [kms\\_alias](#input\\_kms\\_alias) | The ARN of a KMS key used to encrypt and decrypt SecretString values | `string` | `\"aws/ssm\"` | no |\n| \u003ca name=\"input_kms_arn\"\u003e\u003c/a\u003e [kms\\_arn](#input\\_kms\\_arn) | The ARN of a KMS key used to encrypt and decrypt SecretString values | `string` | `\"\"` | no |\n| \u003ca name=\"input_parameter_write\"\u003e\u003c/a\u003e [parameter\\_write](#input\\_parameter\\_write) | List of maps with the parameter values to write to SSM Parameter Store | `list(map(string))` | `[]` | no |\n| \u003ca name=\"input_parameter_write_defaults\"\u003e\u003c/a\u003e [parameter\\_write\\_defaults](#input\\_parameter\\_write\\_defaults) | Parameter write default settings | `map(any)` | \u003cpre\u003e{\u003cbr\u003e  \"allowed_pattern\": null,\u003cbr\u003e  \"data_type\": \"text\",\u003cbr\u003e  \"description\": null,\u003cbr\u003e  \"overwrite\": \"false\",\u003cbr\u003e  \"tier\": \"Standard\",\u003cbr\u003e  \"type\": \"String\"\u003cbr\u003e}\u003c/pre\u003e | no |\n| \u003ca name=\"input_parameter_write_ignore_values\"\u003e\u003c/a\u003e [parameter\\_write\\_ignore\\_values](#input\\_parameter\\_write\\_ignore\\_values) | Feature flag, true or false | `list(map(string))` | `[]` | no |\n| \u003ca name=\"input_prjid\"\u003e\u003c/a\u003e [prjid](#input\\_prjid) | Name of the project/stack e.g: mystack, nifieks, demoaci. Should not be changed after running 'tf apply' | `string` | n/a | yes |\n| \u003ca name=\"input_split_delimiter\"\u003e\u003c/a\u003e [split\\_delimiter](#input\\_split\\_delimiter) | A delimiter for splitting and joining lists together for normalising the output | `string` | `\"~^~\"` | no |\n| \u003ca name=\"input_teamid\"\u003e\u003c/a\u003e [teamid](#input\\_teamid) | Name of the team/group e.g. devops, dataengineering. Should not be changed after running 'tf apply' | `string` | n/a | yes |\n\n## Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_arn_map\"\u003e\u003c/a\u003e [arn\\_map](#output\\_arn\\_map) | A map of the names and ARNs created |\n| \u003ca name=\"output_map\"\u003e\u003c/a\u003e [map](#output\\_map) | A map of the names and values created |\n| \u003ca name=\"output_names\"\u003e\u003c/a\u003e [names](#output\\_names) | A list of all of the parameter names |\n| \u003ca name=\"output_values\"\u003e\u003c/a\u003e [values](#output\\_values) | A list of all of the parameter values |\n\u003c!-- END_TF_DOCS --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomarv2%2Fterraform-aws-parameterstore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftomarv2%2Fterraform-aws-parameterstore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomarv2%2Fterraform-aws-parameterstore/lists"}