https://github.com/bifravst/cloudformation-helpers

Helper functions which simplify working with AWS CloudFormation stacks
https://github.com/bifravst/cloudformation-helpers

aws iot library nrf-asset-tracker

Last synced: 2 days ago
JSON representation

Helper functions which simplify working with AWS CloudFormation stacks

• Host: GitHub
• URL: https://github.com/bifravst/cloudformation-helpers
• Owner: bifravst
• License: bsd-3-clause
• Created: 2021-01-26T15:46:39.000Z (almost 4 years ago)
• Default Branch: saga
• Last Pushed: 2024-11-09T22:53:30.000Z (8 days ago)
• Last Synced: 2024-11-12T09:03:02.507Z (5 days ago)
• Topics: aws, iot, library, nrf-asset-tracker
• Language: TypeScript
• Homepage: https://github.com/bifravst/cloudformation-helpers
• Size: 5.69 MB
• Stars: 3
• Watchers: 6
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# CloudFormation Helpers [![npm version](https://img.shields.io/npm/v/@bifravst/cloudformation-helpers.svg)](https://www.npmjs.com/package/@bifravst/cloudformation-helpers)

[![GitHub Actions](https://github.com/bifravst/cloudformation-helpers/workflows/Test%20and%20Release/badge.svg)](https://github.com/bifravst/cloudformation-helpers/actions)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)

[![@commitlint/config-conventional](https://img.shields.io/badge/%40commitlint-config--conventional-brightgreen)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier/)

[![ESLint: TypeScript](https://img.shields.io/badge/ESLint-TypeScript-blue.svg)](https://github.com/typescript-eslint/typescript-eslint)

Helper functions which simplify working with AWS CloudFormation stacks.

## Installation

    npm i --save-dev --save-exact @bifravst/cloudformation-helpers

## Usage

### `cfnResponse`

`cfnResponse` implements sending custom resource responses.

```typescript

import { cfnResponse, ResponseStatus } from "@bifravst/cloudformation-helpers";

import { CloudFormationCustomResourceEvent } from "aws-lambda";

/**

 * Lambda creating a custom resource

 */

export const handler = async (

  event: CloudFormationCustomResourceEvent,

): Promise => {

  // Create custom resource ...

  await cfnResponse({

    Status: ResponseStatus.SUCCESS,

    event,

    PhysicalResourceId: "MyCustomResource",

  });

};

```