Create, update, and delete your cloudformation stacks with ease
\n\n
\n\t\n
\n\n## Install\n\n```\nnpm i @hydre/cfn\n```\n\n## Use:\n\n```js\nimport { cfn, param } from '@hydre/cfn'\n```\n\n> To print logs you'll need to add the DEBUG env variable with `cfn*`\n\n```\nDEBUG='cfn*' node my-app.js\n```\n\nCreate an api instance (you can create as many as you want with different regions or keys)\n\n```js\nconst api = cfn(apiKey, secretKey, region)\n\n// you can also use AWS_PROFILE env variable or AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY with a custom region\nconst api = cfn(...[, , region])\nconst api = cfn()\n```\n\n> All functions return a promise\n\nValidate a stack (resolve to true or false)\n\n```js\n// the template as a JS object\n// the optional name for debug logs purpose\n.validate(template[, name])\n```\n\nCreate or update a stack (resolve to void or throw an err)\n\n```js\n// [, option] represent default params from the aws sdk when you either create or update a stack\n// if you provide a StackName field in the option param it will override the name param\n.createOrUpdate(name, template[, params][, options])\n```\n\nDelete a stack (resolve to void or throw an err)\n\n```js\n.delete(name)\n```\n\n### Exemple:\n\n```js\nimport { cfn, param } from '@hydre/cfn'\n\nconst { AWS_KEY_FOO, AWS_SECRET_FOO } = process.env\nconst api = new cfn(AWS_KEY_FOO, AWS_SECRET_FOO, 'us-west-1')\n\nconst template = {\n\tAWSTemplateFormatVersion: '2010-09-09',\n\tDescription: 'readme',\n\tResources: []\n}\n\nvoid (async function() {\n\tawait api.validate(template)\n\n\tawait api.createOrUpdate('my-stack', template, [\n\t\tparam('key', 'value'),\n\t\tparam('key', 'value'),\n\t\tparam('key', 'value'),\n\t\tparam('key', 'value')\n\t])\n\n\tawait api.delete('my-stack')\n})()\n```\n\n### Advanced usage\n\n```js\napi.createOrUpdate(...[, , ,], {\n\tStackName: 'STRING_VALUE' /* required */,\n\tCapabilities: [\n\t\tCAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND\n\t\t/* more items */\n\t],\n\tClientRequestToken: 'STRING_VALUE',\n\tDisableRollback: true || false,\n\tEnableTerminationProtection: true || false,\n\tNotificationARNs: [\n\t\t'STRING_VALUE'\n\t\t/* more items */\n\t],\n\tOnFailure: DO_NOTHING | ROLLBACK | DELETE,\n\tParameters: [\n\t\t{\n\t\t\tParameterKey: 'STRING_VALUE',\n\t\t\tParameterValue: 'STRING_VALUE',\n\t\t\tResolvedValue: 'STRING_VALUE',\n\t\t\tUsePreviousValue: true || false\n\t\t}\n\t\t/* more items */\n\t],\n\tResourceTypes: [\n\t\t'STRING_VALUE'\n\t\t/* more items */\n\t],\n\tRoleARN: 'STRING_VALUE',\n\tRollbackConfiguration: {\n\t\tMonitoringTimeInMinutes: 'NUMBER_VALUE',\n\t\tRollbackTriggers: [\n\t\t\t{\n\t\t\t\tArn: 'STRING_VALUE' /* required */,\n\t\t\t\tType: 'STRING_VALUE' /* required */\n\t\t\t}\n\t\t\t/* more items */\n\t\t]\n\t},\n\tStackPolicyBody: 'STRING_VALUE',\n\tStackPolicyURL: 'STRING_VALUE',\n\tTags: [\n\t\t{\n\t\t\tKey: 'STRING_VALUE' /* required */,\n\t\t\tValue: 'STRING_VALUE' /* required */\n\t\t}\n\t\t/* more items */\n\t],\n\tTemplateBody: 'STRING_VALUE',\n\tTemplateURL: 'STRING_VALUE',\n\tTimeoutInMinutes: 'NUMBER_VALUE'\n})\n```\n","readmeFilename":"README.MD"}
![](\"https://img.shields.io/github/license/hydreio/cfn.svg?style=for-the-badge\")
\n \n ![](\"https://img.shields.io/npm/v/@hydre/cfn.svg?logo=npm&style=for-the-badge\")
\n \n ![](\"https://img.shields.io/npm/dw/@hydre/cfn?logo=npm&style=for-the-badge\")
\n ![](\"https://img.shields.io/github/workflow/status/hydreio/cfn/CI?logo=Github&style=for-the-badge\")
\n![](\"https://i.imgur.com/WNmQXz7.png\")
\n