{"id":18347999,"url":"https://github.com/collaborne/serverless-plugin-required-option","last_synced_at":"2025-10-28T22:32:30.867Z","repository":{"id":79155069,"uuid":"329317135","full_name":"Collaborne/serverless-plugin-required-option","owner":"Collaborne","description":"Serverless Framework plugin to require an option to be provided","archived":false,"fork":false,"pushed_at":"2022-04-14T00:46:20.000Z","size":25,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-21T22:38:55.234Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/Collaborne.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-13T13:29:27.000Z","updated_at":"2022-03-18T13:40:21.000Z","dependencies_parsed_at":"2023-04-06T22:34:44.651Z","dependency_job_id":null,"html_url":"https://github.com/Collaborne/serverless-plugin-required-option","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Collaborne%2Fserverless-plugin-required-option","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Collaborne%2Fserverless-plugin-required-option/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Collaborne%2Fserverless-plugin-required-option/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Collaborne%2Fserverless-plugin-required-option/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Collaborne","download_url":"https://codeload.github.com/Collaborne/serverless-plugin-required-option/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248128027,"owners_count":21052342,"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":"2024-11-05T21:16:01.017Z","updated_at":"2025-10-28T22:32:25.815Z","avatar_url":"https://github.com/Collaborne.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# serverless-plugin-required-option\n\nServerless Framework plugin to require an option to be provided\n\n## Usage\n\n1. Install the plugin\n\n    ```sh\n    npm install --save serverless-plugin-required-option\n    ```\n\n2. Add the plugin to the `serverless.yml` configuration file\n\n    ```yaml\n    plugins:\n      - serverless-plugin-required-option\n    ```\n\n3. Use `requiredOpt:NAME` variable references when an option must be provided\n\n    ```yaml\n    custom:\n      userPoolId: ${requiredOpt:user_pool_id}\n    ```\n\n   If the `user_pool_id` is provided as option the `custom.userPoolId` value will be set to it, if the option is not provided\n   then an error will be raised and the serverless operation will be aborted.\n\n## License\n\n```text\nMIT License\n\nCopyright (c) 2021 Collaborne B.V.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcollaborne%2Fserverless-plugin-required-option","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcollaborne%2Fserverless-plugin-required-option","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcollaborne%2Fserverless-plugin-required-option/lists"}