{"_id":"@byu-oit/shared-rds-handel-extension","_rev":"23-50be82fd5f7f64f664bac8423f6cf577","name":"@byu-oit/shared-rds-handel-extension","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@byu-oit/shared-rds-handel-extension","version":"0.1.0","author":{"name":"Scott Hutchings","email":"scott_hutchings@byu.edu"},"license":"Apache-2.0","_id":"@byu-oit/shared-rds-handel-extension@0.1.0","maintainers":[{"name":"arasmus8","email":"arasmus8@gmail.com"},{"name":"garygsc","email":"garygsc@gmail.com"},{"name":"gi60s","email":"james.speirs@gmail.com"},{"name":"lehinpm","email":"lehi_alcantara@byu.edu"},{"name":"mhailstone","email":"matthew.hailstone@gmail.com"},{"name":"oscea","email":"it@byu.edu"},{"name":"pauldeden","email":"byu-oit-npmjs@byu.edu"},{"name":"saholman","email":"spencer.a.holman@gmail.com"},{"name":"thatjoemoore","email":"npm@thatjoemoore.com"},{"name":"yoshutch","email":"scott_hutchings@byu.edu"}],"dist":{"shasum":"d96b253c85ff78dcd9bf92a8de6e9962bc085ce5","tarball":"https://registry.npmjs.org/@byu-oit/shared-rds-handel-extension/-/shared-rds-handel-extension-0.1.0.tgz","fileCount":15,"integrity":"sha512-IOR5S0eHqJU4Pd9gRMHGX9dR88TLAkZ5to2H+OTLWSUogtlLzMWbF6st12pQ3kBxYjixmtqg9Q0ZVRa7Hj2jSw==","signatures":[{"sig":"MEYCIQDEaossxBSfMEKiSFe2eHL+AjRTPkrY0Tz3cyC7YWqq0QIhALTtGcNy7bgeV4vkrOGfjilcnpbMS2mPUjWNTyloEPGS","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":29269,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbGZzDCRA9TVsSAnZWagAA/tMP/RXe5AU8SEPFEM9PTJlX\n0wKtXwgM20MuPMVlQrrVcwAM8x4ixUnUUBlIk92kSe95C1JACF1Ggx7MujWW\nuZ91bQtyOeciLkbfMl4d4A+/OHxoo0tOnhxg1JTN1gDfvUHh07UUPBLqo/Pk\nlrX4pHRuryCCxxF3qo4AiAj0NxwwPoWpbE47zoo8z2qMvNt1GAIv/nTT0sMX\n2F7T6a3L+pSsBT3hV400sgnrW47VYO0DRpni2qp0nm2IvO2Vzaa0K4inRntP\nIttGIT5/ld97Fk7Oryt+DQzWYY6DwwAkP0PoHGgsuOJnv0YA3asDLIeg6e0q\nrDjmK1OMlS0V4lDLBtaLf/rAnpY01ePTHU3zsLOB5eC9anZyhnvIMJLXFvoo\n0YqYdbMQSRVatircp7CYR5n2bc7FYbaaBipEEH47vR6Q9iqICyDf4DsFmdZ4\n/NEFfLrF4AVahu5HbdN1GUng1rQLc/aH/2Ic6RrhgG3nL4oACRTkhkYd+/KC\nsb00ZlTCZKsTLBMb8wiQjnNndox8aAJyJu4/5zrjr5JsRHKLB9JCoIooNsNE\nDpBjwfuUNYrMkF3YgvvGeVaJvRofrk8IwWBD38Mt1ZKnwq7uqDF1dYteY0rJ\n2kcgbNS3RsB4AWiJQRQqrWzyk2GjxbmV9jx7RVeAlyO9HdVTaeGZm4kUI4+c\nfSO5\r\n=1/R6\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/extension.js","engines":{"handel":"*"},"gitHead":"49186699434a0590b01a6eda19211241d97b6a03","scripts":{"test":"gulp build && mocha -r ts-node/register 'test/**/*.ts'","build":"gulp build"},"_npmUser":{"name":"yoshutch","email":"scott_hutchings@byu.edu"},"_npmVersion":"6.0.0","description":"shared rds handel extension","directories":{},"_nodeVersion":"8.9.4","dependencies":{"aws-sdk":"^2.240.1","handel-extension-api":"^0.26.8","handel-extension-support":"^0.26.8"},"_hasShrinkwrap":false,"devDependencies":{"chai":"^4.1.2","gulp":"^3.9.1","mocha":"^5.0.5","sinon":"^4.5.0","tslint":"^5.9.1","ts-node":"^5.0.1","fs-extra":"^5.0.0","typescript":"^2.8.1","@types/chai":"^4.1.2","@types/node":"^9.6.4","@types/mocha":"^5.0.0","@types/sinon":"^4.3.1","merge-stream":"^1.0.1","run-sequence":"^2.2.0","@types/winston":"^2.3.9","gulp-typescript":"^3.2.3"},"_npmOperationalInternal":{"tmp":"tmp/shared-rds-handel-extension_0.1.0_1528405186054_0.818639729866081","host":"s3://npm-registry-packages"}}},"time":{"created":"2018-06-07T20:59:45.850Z","modified":"2026-07-06T18:20:37.604Z","0.1.0":"2018-06-07T20:59:46.163Z"},"author":{"name":"Scott Hutchings","email":"scott_hutchings@byu.edu"},"license":"Apache-2.0","description":"shared rds handel extension","maintainers":[{"email":"scott_hutchings@byu.edu","name":"yoshutch"},{"email":"lehi_alcantara@byu.edu","name":"lehinpm"},{"email":"it@byu.edu","name":"oscea"},{"email":"stuft2@protonmail.com","name":"stuft2"},{"email":"matthew.hailstone@gmail.com","name":"mhailstone"},{"email":"arasmus8@gmail.com","name":"arasmus8"},{"email":"garygsc@gmail.com","name":"garygsc"},{"email":"github@snelg.com","name":"snelg"},{"email":"danielduraesm@gmail.com","name":"gholl0"},{"email":"developertools@byu.edu","name":"byu-oit-bot"},{"email":"micah.weatherhead@gmail.com","name":"mjweather"},{"email":"jvisker@byu.edu","name":"jvisker"}],"readme":"# Shared RDS Handel Extension\r\nThis is an extension for [handel](https://handel.readthedocs.io/en/latest/) that will create a database inside of a shared RDS instance.\r\n\r\n### *Note*\r\n*This extension will only work if the [shared-rds-iac](https://github.com/byu-oit/shared-rds-iac) infrasctructure is deployed on the AWS account you are deploying your app to.*\r\n\r\nWhen using this extension, it will create a database within a shared RDS instance and then create 3 database users that only have access to that database. One user is the admin user for that database with all access to the database. One read-write user and a read-only user.\r\n\r\n## Parameters\r\n| Parameter | Type | Required | Description |\r\n| --- | --- | --- | --- |\r\n| type | string | Yes | This must be *\\<extension_name\\>::mysql* for this service type.|\r\n| database_name | string | Yes | The name of your database in the shared MySQL instance. |\r\n\r\n## Example Handel File\r\n```\r\nversion: 1\r\n\r\nname: test\r\n\r\nextensions:\r\n  shared: shared-rds-handel-extension\r\n\r\nenvironments:\r\n  dev:\r\n    shared-db:\r\n      type: shared::mysql\r\n      database_name: test_db\r\n    test-lambda:\r\n      type: lambda\r\n      path_to_code: src\r\n      handler: handler.lambda_handler\r\n      runtime: python3.6\r\n      vpc: true\r\n      dependencies:\r\n      - shared-db\r\n\r\n```\r\n## Depending on this Service\r\nThe shared MySQL service outputs the following environment variables:\r\n\r\n| Environment Variable | Description |\r\n| --- | --- |\r\n| <SERVICE_NAME>_ADDRESS | The DNS name of the MySQL database address. |\r\n| <SERVICE_NAME>_PORT | The port on which the MySQL instance is listening. |\r\n| <SERVICE_NAME>_DATABASE_NAME | The name of the database in the shared MySQL instance. |\r\n| <SERVICE_NAME>_ADMIN_USERNAME | The username of the admin user for your database. |\r\n| <SERVICE_NAME>_READ_WRITE_USERNAME | The username of the read-write user for your database. |\r\n| <SERVICE_NAME>_READ_ONLY_USERNAME | The username of the read-only user for your database. |\r\n| <SERVICE_NAME>_ADMIN_PASSWORD_PARAM_NAME | The parameter name for the admin user's password. |\r\n| <SERVICE_NAME>_READ_WRITE_PASSWORD_PARAM_NAME | The parameter name for the read-write user's password. |\r\n| <SERVICE_NAME>_READ_ONLY_PASSWORD_PARAM_NAME | The parameter name for the read-only user's password. |\r\n\r\nIn addition, the shared MySQL service puts the following credentials into the EC2 parameter store:\r\n\r\n| Parameter Name | Description |\r\n| --- | --- |\r\n| <parameter_prefix>.<service_name>.db_admin_password | The password for the admin user. |\r\n| <parameter_prefix>.<service_name>.db_read_write_password | The password for the read-write user. |\r\n| <parameter_prefix>.<service_name>.db_read_only_password | The password for the read-only user. |\r\n\r\n","readmeFilename":"README.md"}