{"id":19437852,"url":"https://github.com/architect/plugin-storage-private","last_synced_at":"2025-04-24T21:32:20.212Z","repository":{"id":43846095,"uuid":"198751372","full_name":"architect/plugin-storage-private","owner":"architect","description":"Architect serverless framework macro that defines any number of arbitrary private S3 buckets","archived":false,"fork":false,"pushed_at":"2022-02-16T04:31:55.000Z","size":32,"stargazers_count":4,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-15T12:08:29.527Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"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/architect.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":".github/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":".github/code_of_conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-25T03:37:10.000Z","updated_at":"2024-09-30T00:13:03.000Z","dependencies_parsed_at":"2022-09-12T05:40:45.783Z","dependency_job_id":null,"html_url":"https://github.com/architect/plugin-storage-private","commit_stats":null,"previous_names":["architect/macro-storage-private"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architect%2Fplugin-storage-private","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architect%2Fplugin-storage-private/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architect%2Fplugin-storage-private/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architect%2Fplugin-storage-private/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/architect","download_url":"https://codeload.github.com/architect/plugin-storage-private/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250713112,"owners_count":21475134,"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-10T15:16:04.450Z","updated_at":"2025-04-24T21:32:19.954Z","avatar_url":"https://github.com/architect.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[\u003cimg src=\"https://assets.arc.codes/architect-logo-500b@2x.png\" width=500\u003e](https://www.npmjs.com/package/@architect/architect)\n\n## [`@architect/plugin-storage-private`](https://www.npmjs.com/package/@architect/plugin-storage-private)\n\n\u003e Architect serverless framework plugin that defines any number of arbitrary **private** S3 buckets for your application\n\n[`@architect/plugin-storage-private`](https://www.npmjs.com/package/@architect/plugin-storage-private) provisions **private** S3 buckets for your application. If you need to provision **public** S3 buckets, check out [`@architect/plugin-storage-public`](https://www.npmjs.com/package/@architect/plugin-storage-public).\n\n\n## Installation\n\n1. Run: `npm i @architect/plugin-storage-private`\n\n2. Then add the following line to the `@plugins` pragma in your Architect project manifest (usually `.arc`):\n\n\u003e Note, no `@` in the plugin name!\n\n```\n@plugins\narchitect/plugin-storage-private\n```\n\n3. Add a new `@storage-private` pragma\n\nDefine any number of S3 bucket names within `@storage-private`; the following characters are allowed: `[a-zA-Z0-9_-]`\n\n```\n@storage-private\nsensitive-data\nsecureinfo\n```\n\n\n## Accessing your bucket names\n\n- CloudFormation provisions these buckets, and by default your bucket name will be reformatted and provided a GUID by AWS\n- Thus, to deterministically access your bucket name, your Lambdas will be assigned a `ARC_STORAGE_PRIVATE_\u003cbucketname\u003e` env var (with any dashes converted to underscores)\n  - Example: your app is named `myapp`, and your bucket is named `sensitive-data` in your `app.arc` file\n  - Your Lambda(s) would read the `ARC_STORAGE_PRIVATE_SENSITIVE_DATA` env var (which would be assigned a value similar to `myappstaging-sensitivedatabucket-1f8394rh4qtvb`)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchitect%2Fplugin-storage-private","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farchitect%2Fplugin-storage-private","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchitect%2Fplugin-storage-private/lists"}