{"id":18728344,"url":"https://github.com/fluidtrends/awsome","last_synced_at":"2025-04-12T16:33:03.178Z","repository":{"id":57196117,"uuid":"41195267","full_name":"fluidtrends/awsome","owner":"fluidtrends","description":"Manage your AWS infrastructure with AWSome, as if it were composed of plain objects.","archived":false,"fork":false,"pushed_at":"2020-04-22T04:37:49.000Z","size":1984,"stargazers_count":20,"open_issues_count":12,"forks_count":3,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-26T11:11:14.108Z","etag":null,"topics":["aws","devops","route53","s3"],"latest_commit_sha":null,"homepage":"","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/fluidtrends.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":"2015-08-22T07:00:26.000Z","updated_at":"2022-02-19T18:52:00.000Z","dependencies_parsed_at":"2022-09-16T12:21:51.980Z","dependency_job_id":null,"html_url":"https://github.com/fluidtrends/awsome","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluidtrends%2Fawsome","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluidtrends%2Fawsome/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluidtrends%2Fawsome/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluidtrends%2Fawsome/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fluidtrends","download_url":"https://codeload.github.com/fluidtrends/awsome/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248596673,"owners_count":21130743,"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","devops","route53","s3"],"created_at":"2024-11-07T14:20:45.735Z","updated_at":"2025-04-12T16:33:02.218Z","avatar_url":"https://github.com/fluidtrends.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/fluidtrends/awsome/master/logo.png\" width=\"256px\"\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003e AWSome\n\u003cimg src=\"https://img.shields.io/npm/v/awsome.svg\"/\u003e\n\u003c/h1\u003e\n\n\u003ch3 align=\"center\"\u003e AWS Object Management Environment \u003c/h3\u003e\n\u003cp align=\"center\"\u003e Manage your AWS infrastructure as if it were composed of plain objects.\n\u003c/p\u003e\n\u003chr/\u003e\n\n## Build Status [![Build](https://circleci.com/gh/fluidtrends/awsome.svg?style=svg)](https://circleci.com/gh/fluidtrends/awsome)\n\n[![Coverage](https://api.codeclimate.com/v1/badges/bcf4dae241b12298574c/test_coverage)](https://codeclimate.com/github/fluidtrends/awsome/test_coverage)\n[![Maintainability](https://api.codeclimate.com/v1/badges/bcf4dae241b12298574c/maintainability)](https://codeclimate.com/github/fluidtrends/awsome/maintainability)\n[![Style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com)\n\n## Getting Started\n\nMake your AWS credentials available in the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables and then just import AWSome to get started.\n\n```javascript\n// Import AWSome\nconst awsome = require('awsome')\n\n// Create a new bucket instance\nconst bucket = new awsome.Bucket({ name: 'my-test-bucket' })\n\n// Fetch the bucket data\nbucket.retrieve()\n      .then((data) =\u003e {\n        // Good stuff, enjoy the data\n      })\n      .catch((error) =\u003e {\n        // Something happened and the bucket data could not be retrieved\n      })\n```\n\n## Examples\n\nGet started with the examples provided to **create**, **retrieve**, **update** or **delete** buckets and to **host**, **unhost** domains as well as to **link** and **unlink** domains and buckets. Make sure you have your AWS key and secret ready.\n\n```bash\nnode ./node_modules/awsome/examples key=\u003cINSERT AWS KEY\u003e secret=\u003cINSERT AWS SECRET\u003e example=create-bucket\n```\n\nThe supported examples are:\n\n* [```create-bucket``` Creating a bucket](https://github.com/fluidtrends/awsome/blob/master/examples/create-bucket.js)\n* [```retrieve-bucket``` Retrieving a bucket](https://github.com/fluidtrends/awsome/blob/master/examples/retrieve-bucket.js)\n* [```update-bucket``` Updating a bucket](https://github.com/fluidtrends/awsome/blob/master/examples/update-bucket.js)\n* [```delete-bucket``` Deleting a bucket](https://github.com/fluidtrends/awsome/blob/master/examples/delete-bucket.js)\n* [```host-domain``` Hosting a domain](https://github.com/fluidtrends/awsome/blob/master/examples/host-domain.js)\n* [```unhost-domain``` Unhosting a domain](https://github.com/fluidtrends/awsome/blob/master/examples/unhost-domain.js)\n* [```link-bucket``` Linking bucket to a domain](https://github.com/fluidtrends/awsome/blob/master/examples/link-bucket.js)\n* [```unlink-bucket``` Unlinking a bucket from a domain](https://github.com/fluidtrends/awsome/blob/master/examples/unlink-bucket.js)\n\n[See All The Examples](/examples)\n\n## Tutorials\n\nThere is a detailed [Getting Started](tutorials/start) tutorial that you can read to set your AWS account up, to install and to start using AWSome right away.\n\nHave a look at [all the tutorials available](tutorials) to make the most of AWSsome.\n\n## Documentation\n\nAWSome is very well documented and all objects, options, fields and functions are well explained and they all include examples.\n\nRead the full documentation for detailed instructions on how to create, retrieve, update and delete buckets, including site buckets, host and unhost domains and link and unlink domains and buckets.\n\n[Read The Docs](/docs)\n\n## Contributing\n\nWe'd be glad to have you join us as an AWSome Contributor. Get started by reading our Contributor Guide.\n\n[Read The Contributor Guide](/contrib)\n\n## Dependencies\n\nAWSome makes use of the following libraries:\n\n* [aws sdk](https://github.com/aws/aws-sdk-js) - for AWS calls\n* [cross-env](https://github.com/kentcdodds/cross-env) - for running examples\n* [fs-extra](https://github.com/jprichardson/node-fs-extra) - for file management\n* [walk](https://github.com/Daplie/node-walk) - for file tree walking\n* [uuid](https://github.com/kelektiv/node-uuid) - for generating hosted zone references\n* [tldjs](https://github.com/oncletom/tld.js) - for parsing domain names\n* [savor](https://github.com/fluidtrends/savor) - for testing\n\n## License\n\nAWSome is licensed under the MIT License.\n\n* [Read The License](LICENSE)\n\n## Sponsors\n\nAWSome is sponsored by [Fluid Trends](http://fluidtrends.com) and is part of the Fluid Trends Open Source Lab.\n\nIf you'd like to co-sponsor this project, please email your co-sponsorship request to **team at fluidtrends.com**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffluidtrends%2Fawsome","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffluidtrends%2Fawsome","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffluidtrends%2Fawsome/lists"}