SNS/SQS Event Configurations

The SNS/SQS event will automatically handle many common things done when eventing off a SNS/SQS stream. Developers then have the ability to further extend that functionality with custom middleware. Below is a full list of all the configurations available and examples of their use.

Example

Don't like reading documentation? Then look at our examples which can be deploy in 1 command into your AWS account!

Configuration Options

option	type	required	default	description
before	func	no	null	a custom function to be ran before your records are pulled
dataClass	class	no	null	a custom class that will be passed instead of the records object
globalLogger	bool	no	false	will assign the ALC logger to the global variable globalLogger
requiredBody	str or obj	no	null	will validate body of record against this schema
schemaPath	str	no	null	file path pointing to the location of the openapi.yml file
validationError	bool	no	false	will raise exception if validation of record fails

Example: SNS/SQS Configuration Options

const EventClient = require('@syngenta-digital/alc').sqs.Event;
const Grower = require('api/logic/grower');

exports.listen = async (event) => {
    const options = {
        globalLogger: true,
        requiredBody: 'sqs-record',
        schemaPath: 'api/openapi.yml',
        validationError: false, // will raise exception if validation fails;  default false
        dataClass: Grower, // will get instance of this instead of record instance
        before: (records) => {
            // run this before records are sent
        }
    }
    const eventClient = new EventClient(event, options);
    const records = await eventClient.getRecords();
    for (const grower of records) {
        // do stuff here
    }
};