{"id":16773305,"url":"https://github.com/aeksco/aws-s3-bucket-maker","last_synced_at":"2025-04-10T20:03:38.045Z","repository":{"id":55704871,"uuid":"318945274","full_name":"aeksco/aws-s3-bucket-maker","owner":"aeksco","description":":boom: Builds a self-destructing S3 bucket and associated IAM Role for temporary file transfer workflows","archived":false,"fork":false,"pushed_at":"2020-12-13T03:32:00.000Z","size":114,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-24T17:51:49.318Z","etag":null,"topics":["aws","aws-cdk","aws-s3","cdk","cloudformation","iam","iam-policy","iam-user","jest","lambda","s3","self-destruct","serverless","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/aeksco.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":"2020-12-06T03:50:26.000Z","updated_at":"2020-12-16T16:28:27.000Z","dependencies_parsed_at":"2022-08-15T06:31:02.521Z","dependency_job_id":null,"html_url":"https://github.com/aeksco/aws-s3-bucket-maker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeksco%2Faws-s3-bucket-maker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeksco%2Faws-s3-bucket-maker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeksco%2Faws-s3-bucket-maker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeksco%2Faws-s3-bucket-maker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aeksco","download_url":"https://codeload.github.com/aeksco/aws-s3-bucket-maker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248287690,"owners_count":21078759,"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-cdk","aws-s3","cdk","cloudformation","iam","iam-policy","iam-user","jest","lambda","s3","self-destruct","serverless","typescript"],"created_at":"2024-10-13T06:45:23.554Z","updated_at":"2025-04-10T20:03:38.016Z","avatar_url":"https://github.com/aeksco.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aws-s3-bucket-maker\n\n:mag: Builds a self-destructing S3 bucket and associated IAM Role for temporary file transfer workflows. Built with AWS CDK + TypeScript.\n\n![S3 Bucket Maker Diagram](https://i.imgur.com/X1wQ6m1.png \"S3 Bucket Maker Diagram\")\n\n\u003c!-- https://app.cloudcraft.co/blueprint/1202bf1e-7678-4db6-8e01-cf863e4f41c8 --\u003e\n\n**Getting Started**\n\nRun the following commands to install dependencies, build the CDK stack, and deploy the CDK Stack to AWS.\n\n```\nyarn install\nyarn build\ncdk bootstrap\ncdk deploy\n```\n\nNote that `EMAIL_SOURCE`, `EMAIL_ADMIN`, and `EMAIL_RECIPIENT` environment variables must be defined for `cdk bootstrap` and `cdk deploy`:\n\n- `EMAIL_SOURCE` - the email being used by SES to send messages to `EMAIL_ADMIN` and `EMAIL_RECIPIENT`.\n- `EMAIL_ADMIN` - the email of the administrator creating the S3 bucket and IAM user\n- `EMAIL_RECIPIENT` - the email of the recipient of the S3 bucket read + write credentials\n\nThe simplest way to inject these variables into the environment is simply by defining them before invoking `cdk bootstrap` or `cdk deploy`:\n\n```\nEMAIL_SOURCE=source@test.com EMAIL_ADMIN=admin@test.com EMAIL_RECIPIENT=recipient@test.com cdk deploy\n```\n\n### Overview\n\nThe following is an overview of each process performed by this CDK stack:\n\n- Create S3 bucket\n- Create IAM Role\n- Create IAM Policies\n- Send email to admin with login credentials\n- Send email to recipient user with login credentials\n- Send delete reminder after 29 days\n- Delete everything after 30 days\n- Send delete confirmation email\n\n### Scripts\n\n- `yarn install` - installs dependencies\n- `yarn build` - builds the production-ready CDK Stack\n- `yarn test` - runs Jest\n- `cdk bootstrap` - bootstraps AWS Cloudformation for your CDK deploy\n- `cdk deploy` - deploys the CDK stack to AWS\n\n**Notes**\n\n- Includes tests with Jest.\n\n- Recommended to use `Visual Studio Code` with the `Format on Save` setting turned on.\n\n**Built with**\n\n- [TypeScript](https://www.typescriptlang.org/)\n- [Jest](https://jestjs.io)\n- [AWS CDK](https://aws.amazon.com/cdk/)\n- [AWS Lambda](https://aws.amazon.com/lambda/)\n- [AWS S3](https://aws.amazon.com/s3/)\n- [AWS SES](https://aws.amazon.com/ses/)\n- [AWS IAM](https://aws.amazon.com/iam/)\n\n**Additional Resources**\n\n- [CDK API Reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-construct-library.html)\n- [CDK TypeScript Reference](https://docs.aws.amazon.com/cdk/api/latest/typescript/api/index.html)\n- [CDK Assertion Package](https://github.com/aws/aws-cdk/tree/master/packages/%40aws-cdk/assert)\n- [awesome-cdk repo](https://github.com/eladb/awesome-cdk)\n- [aws-pdf-textract-pipeline](https://github.com/aeksco/aws-pdf-textract-pipeline)\n\n**License**\n\nOpensourced under the MIT License.\n\nBuilt with :heart: \u0026nbsp;by [aeksco](https://twitter.com/aeksco)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faeksco%2Faws-s3-bucket-maker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faeksco%2Faws-s3-bucket-maker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faeksco%2Faws-s3-bucket-maker/lists"}