JSPM

@benhepburn/adonis-notifications-aws-sns-channel

1.6.0
    • ESM via JSPM
    • ES Module Entrypoint
    • Export Map
    • Keywords
    • License
    • Repository URL
    • TypeScript Types
    • README
    • Created
    • Published
    • Downloads 36
    • Score
      100M100P100Q75909F
    • License MIT

    An AWS SNS notification channel for @benhepburn/adonis-notifications

    Package Exports

    • @benhepburn/adonis-notifications-aws-sns-channel
    • @benhepburn/adonis-notifications-aws-sns-channel/types

    Readme

    AdonisJS Notifications - AWS SNS Channel

    This package requires @benhepburn/adonis-notifications and @aws-sdk/credential-providers.

    Install

    Install peer dependency @aws-sdk/credential-providers and this package from npm:

    npm install @aws-sdk/credential-providers @benhepburn/adonis-notifications-aws-sns-channel

    or

    pnpm install @aws-sdk/credential-providers @benhepburn/adonis-notifications-aws-sns-channel

    or

    yarn add @aws-sdk/credential-providers @benhepburn/adonis-notifications-aws-sns-channel

    Then, configure the package for Adonis:

    node ace configure @benhepburn/adonis-notifications-aws-sns-channel

    Configuration

    Edit config/aws_sns_channel.ts as needed, then add the channel to config/notifications.ts.

    You must set the AWS region:

    AWS_SNS_REGION=<region e.g. ap-southeast-2>

    You can set the AWS credentials in your .env file; if they aren't set then the default node credentials provider for AWS will be used.