node-ts/bus

Add more explanations on integrating AWS SQS

Zehelein opened this issue · 0 comments

[x] Documentation enhancement

I got the SQS integration working but I am not 100% if all the steps are correct/if you have some better way/other suggestions.

  1. Create a policy in the Identity and Access Management (IAM) section
    • KMS: likely list+read would be enough? I allowed it for "All resources"
    • SQS: likely all but permission management and tagging are needed?
    • SNS: same as SQS
    • anything else like S3 or such would not be needed
  2. Setting environment variables (I am using dotenv for it). But it seems there are different approaches like config file or directly setting it in the SQS/SNS constructor. Maybe you use a different approach.
    • AWS_REGION e.g. eu-central-1
    • AWS_ACCESS_KEY_ID (20 characters)
    • AWS_SECRET_ACCESS_KEY (40 characters)
  3. The queue and dead-letter queue names must be unique per service.

I think in the SQS example there is one typo. Line 4 should be:
import { BUS_SQS_SYMBOLS, BusSqsModule, SqsTransportConfiguration } from '@node-ts/bus-sqs'