{"id":24991684,"url":"https://github.com/constup/aws-secrets-bundle","last_synced_at":"2025-04-19T20:46:18.304Z","repository":{"id":39790439,"uuid":"399052610","full_name":"constup/aws-secrets-bundle","owner":"constup","description":"Use AWS Secrets as service container parameters in Symfony.","archived":false,"fork":false,"pushed_at":"2024-04-24T13:08:56.000Z","size":70,"stargazers_count":11,"open_issues_count":3,"forks_count":14,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-06T05:16:26.114Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"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/constup.png","metadata":{"files":{"readme":"README.md","changelog":null,"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-08-23T09:55:50.000Z","updated_at":"2025-01-28T17:09:18.000Z","dependencies_parsed_at":"2022-09-18T21:38:52.971Z","dependency_job_id":null,"html_url":"https://github.com/constup/aws-secrets-bundle","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/constup%2Faws-secrets-bundle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/constup%2Faws-secrets-bundle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/constup%2Faws-secrets-bundle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/constup%2Faws-secrets-bundle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/constup","download_url":"https://codeload.github.com/constup/aws-secrets-bundle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249796109,"owners_count":21326780,"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":[],"created_at":"2025-02-04T13:51:35.717Z","updated_at":"2025-04-19T20:46:18.237Z","avatar_url":"https://github.com/constup.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# AWS Secrets Bundle\n\n[![GitHub license](https://img.shields.io/github/license/constup/aws-secrets-bundle?style=flat-square\u0026color=green)](https://github.com/constup/aws-secrets-bundle/blob/master/LICENSE)\n![PHP version](https://img.shields.io/badge/PHP-%5E7.4-blueviolet?style=flat-square)\n![Symfony](https://img.shields.io/badge/Symfony-%5E5.3-blueviolet?style=flat-square)\n\nUse AWS Secrets as service container parameters in Symfony.\n\n## History and honorable mentions\n\nThis bundle is loosely based on and inspired by `incompass/aws-secrets-bundle` (https://github.com/casechek/aws-secrets-bundle). \nThe Incompass bundle is compatible with Symfony 3 and 4, and it looks like it's not updated/maintained anymore. This \npackage is built to be compatible with Symfony 5 and will, over time, get improvements.\n\nIf you are still using Symfony 3 or 4, please use the Incompass bundle instead of this one.\n\n## Prerequisites\n\n### Install AWS SDK\n\nSince the official recommendation from Symfony is: `A bundle must not embed third-party PHP libraries. \nIt should rely on the standard Symfony autoloading instead.`, the `aws/aws-sdk-php` Composer package is included in this \nbundle only as a dev dependency (for testing purposes).\n\nYou need to install AWS SDK for PHP in your project yourself:\n\n```shell\ncomposer require aws/aws-sdk-php\n```\n\n### AWS credentials\n\nIn order to connect to any AWS service (for example: AWS Secrets Manager), your application must be authenticated on \nthat AWS service. Since there are several scenarios for this, depending on your environment setup, configuring \nenvironments and using credentials is covered here: [AWS credentials and authentication](./doc/aws_credentials.md)\n\n## Installation\n\nThere are two main versions of AWS Secrets bundle: 1.x and 2.x.\n\nInstall version 1.x to use this package with Symfony 5.x (5.3+) and PHP 7.4.\n\n    $ composer require constup/aws-secrets-bundle:^1\n\nInstall version 2.x to use this package with Symfony 6.x and PHP 8.x.\n\n    $ composer require constup/aws-secrets-bundle:^2\n\n## Configuration\n\nBy default, configuration for this bundle is loaded from `config/packages/aws_secrets.yaml` file or its \nenvironment-specific alternatives (for example: `config/packages/test/aws_secrets.yaml`). The following configuration\nproperties are available:\n\n```yaml\naws_secrets:\n  client_config:\n    region:           # Required if \"ignore\" is false.\n    version: 'latest' # Defaults to \"latest\".\n    endpoint: ~\n    credentials: \n        key: ~\n        secret: ~\n  cache: 'array'      # Can be one of the following: apcu, array, filesystem. Default is array.\n  delimiter: ','      # Delimiter to separate key from secret name.\n  ignore: false       # Pass through AWS (for local dev environments set to \"true\").\n```\n\n## Usage\n\nSet an env var to an AWS Secret Manager Secret name like so:\n\n    AWS_SECRET=secret_name\n\nIf you want to grab a key in a JSON secret, you can separate the secret name and key:\n\n    AWS_SECRET=secret_name,key\n    \nSet a parameter to this environment variable with the aws processor:\n\n```yaml\nparameters:\n    my_parameter: '%env(aws:AWS_SECRET)%'\n```\n\nYour secret will now be loaded at runtime!\n\n## Development notes\n\n- `master` branch only contains documentation.\n- `di5` branch is compatible with PHP 7.4+ and Symfony Dependency Injection 5.3+. Release tags for this branch are 1.x.x\n- `di6` branch is compatible with PHP 8.x and Symfony Dependency Injection 6.0+. Release tags for this branch are 2.x.x\n\n## Examples\n\n* [Configure Doctrine to use AWS Secret values as MySQL connection parameters](./doc/sample_doctrine_mysql_connection.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconstup%2Faws-secrets-bundle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconstup%2Faws-secrets-bundle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconstup%2Faws-secrets-bundle/lists"}