AWS Utility Documentation

This utility provides easy access to AWS services like SSM (Systems Manager), Secrets Manager, and SQS (Simple Queue Service).

Table of Contents

Constructor

constructor(_region: string)

Initializes a new instance with specified AWS region

Creates SSM and Secrets Manager utility instances

Properties:

region: AWS region string

ssm: SSM utility instance

secret: Secrets Manager utility instance

sqs: SQS utility instance

Features:

Parameter Store operations

Document management

Automation execution

const awsUtil = new RL_AWSUtility('us-east-1');
const ssmClient = awsUtil.ssm;

Secrets Manager Utility The Secrets Manager utility helps manage sensitive information securely.

Features:

Secret creation and management

Secure storage of credentials

Automatic secret rotation

const awsUtil = new RL_AWSUtility('us-east-1');
const secretClient = awsUtil.secret;

SQS Utility The SQS utility provides methods to interact with Amazon Simple Queue Service for message queuing.

Features:

Support for both Standard and FIFO queues

Message sending

Queue management operations

Standard Queue Operations

const awsUtil = new RL_AWSUtility('us-east-1');
const sqsClient = awsUtil.sqs;

// Send message to standard queue 

await sqsClient.postMsgToStdQueue(
    JSON.stringify({ data: 'message content' }),
    'queue-url'
);

FIFO Queue Operations

const awsUtil = new RL_AWSUtility('us-east-1');
const sqsClient = awsUtil.sqs;


// Send message to FIFO queue
await sqsClient.postMsgToFifoQueue(
    JSON.stringify({ data: 'message content' }),
    'queue-url',
    'message-group-id'
);