@epilot360/icons 0.0.1 → 0.0.2

package/iac/node_modules/aws-cdk-lib/aws-lambda-destinations/README.md

@@ -0,0 +1,147 @@
+# Amazon Lambda Destinations Library
+
+
+This library provides constructs for adding destinations to a Lambda function.
+Destinations can be added by specifying the `onFailure` or `onSuccess` props when creating a function or alias.
+
+## Destinations
+
+The following destinations are supported
+
+* Lambda function
+* SQS queue - Only standard SQS queues are supported for failure destinations, FIFO queues are not supported.
+* SNS topic
+* EventBridge event bus
+
+Example with a SNS topic for successful invocations:
+
+```ts
+// An sns topic for successful invocations of a lambda function
+import * as sns from 'aws-cdk-lib/aws-sns';
+
+const myTopic = new sns.Topic(this, 'Topic');
+
+const myFn = new lambda.Function(this, 'Fn', {
+  runtime: lambda.Runtime.NODEJS_14_X,
+  handler: 'index.handler',
+  code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),
+  // sns topic for successful invocations
+  onSuccess: new destinations.SnsDestination(myTopic),
+})
+```
+
+Example with a SQS queue for unsuccessful invocations:
+
+```ts
+// An sqs queue for unsuccessful invocations of a lambda function
+import * as sqs from 'aws-cdk-lib/aws-sqs';
+
+const deadLetterQueue = new sqs.Queue(this, 'DeadLetterQueue');
+
+const myFn = new lambda.Function(this, 'Fn', {
+  runtime: lambda.Runtime.NODEJS_14_X,
+  handler: 'index.handler',
+  code: lambda.Code.fromInline('// your code'),
+  // sqs queue for unsuccessful invocations
+  onFailure: new destinations.SqsDestination(deadLetterQueue),
+});
+```
+
+See also [Configuring Destinations for Asynchronous Invocation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations).
+
+### Invocation record
+
+When a lambda function is configured with a destination, an invocation record is created by the Lambda service
+when the lambda function completes. The invocation record contains the details of the function, its context, and
+the request and response payloads.
+
+The following example shows the format of the invocation record for a successful invocation:
+
+```json
+{
+	"version": "1.0",
+	"timestamp": "2019-11-24T23:08:25.651Z",
+	"requestContext": {
+		"requestId": "c2a6f2ae-7dbb-4d22-8782-d0485c9877e2",
+		"functionArn": "arn:aws:lambda:sa-east-1:123456789123:function:event-destinations:$LATEST",
+		"condition": "Success",
+		"approximateInvokeCount": 1
+	},
+	"requestPayload": {
+		"Success": true
+	},
+	"responseContext": {
+		"statusCode": 200,
+		"executedVersion": "$LATEST"
+	},
+	"responsePayload": "<data returned by the function here>"
+}
+```
+
+In case of failure, the record contains the reason and error object:
+
+```json
+{
+  "version": "1.0",
+  "timestamp": "2019-11-24T21:52:47.333Z",
+  "requestContext": {
+    "requestId": "8ea123e4-1db7-4aca-ad10-d9ca1234c1fd",
+    "functionArn": "arn:aws:lambda:sa-east-1:123456678912:function:event-destinations:$LATEST",
+    "condition": "RetriesExhausted",
+    "approximateInvokeCount": 3
+  },
+  "requestPayload": {
+    "Success": false
+  },
+  "responseContext": {
+    "statusCode": 200,
+    "executedVersion": "$LATEST",
+    "functionError": "Handled"
+  },
+  "responsePayload": {
+    "errorMessage": "Failure from event, Success = false, I am failing!",
+    "errorType": "Error",
+    "stackTrace": [ "exports.handler (/var/task/index.js:18:18)" ]
+  }
+}
+```
+
+#### Destination-specific JSON format
+
+* For SNS/SQS (`SnsDestionation`/`SqsDestination`), the invocation record JSON is passed as the `Message` to the destination.
+* For Lambda (`LambdaDestination`), the invocation record JSON is passed as the payload to the function.
+* For EventBridge (`EventBridgeDestination`), the invocation record JSON is passed as the `detail` in the PutEvents call.
+The value for the event field `source` is `lambda`, and the value for the event field `detail-type`
+is either 'Lambda Function Invocation Result - Success' or 'Lambda Function Invocation Result – Failure',
+depending on whether the lambda function invocation succeeded or failed. The event field `resource`
+contains the function and destination ARNs. See [AWS Events](https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html)
+for the different event fields.
+
+### Auto-extract response payload with lambda destination
+
+The `responseOnly` option of `LambdaDestination` allows to auto-extract the response payload from the
+invocation record:
+
+```ts
+// Auto-extract response payload with a lambda destination
+declare const destinationFn: lambda.Function;
+
+const sourceFn = new lambda.Function(this, 'Source', {
+  runtime: lambda.Runtime.NODEJS_14_X,
+  handler: 'index.handler',
+  code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),
+  // auto-extract on success
+  onSuccess: new destinations.LambdaDestination(destinationFn, {
+    responseOnly: true,
+  }),
+})
+```
+
+In the above example, `destinationFn` will be invoked with the payload returned by `sourceFn`
+(`responsePayload` in the invocation record, not the full record).
+
+When used with `onFailure`, the destination function is invoked with the error object returned
+by the source function.
+
+Using the `responseOnly` option allows to easily chain asynchronous Lambda functions without
+having to deal with data extraction in the runtime code.

package/iac/node_modules/aws-cdk-lib/aws-lambda-event-sources/README.md

@@ -0,0 +1,281 @@
+# AWS Lambda Event Sources
+
+
+An event source mapping is an AWS Lambda resource that reads from an event source and invokes a Lambda function.
+You can use event source mappings to process items from a stream or queue in services that don't invoke Lambda
+functions directly. Lambda provides event source mappings for the following services. Read more about lambda
+event sources [here](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html).
+
+This module includes classes that allow using various AWS services as event
+sources for AWS Lambda via the high-level `lambda.addEventSource(source)` API.
+
+NOTE: In most cases, it is also possible to use the resource APIs to invoke an
+AWS Lambda function. This library provides a uniform API for all Lambda event
+sources regardless of the underlying mechanism they use.
+
+The following code sets up a lambda function with an SQS queue event source -
+
+```ts
+import { SqsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
+
+declare const fn: lambda.Function;
+const queue = new sqs.Queue(this, 'MyQueue');
+const eventSource = new SqsEventSource(queue);
+fn.addEventSource(eventSource);
+
+const eventSourceId = eventSource.eventSourceMappingId;
+```
+
+The `eventSourceId` property contains the event source id. This will be a
+[token](https://docs.aws.amazon.com/cdk/latest/guide/tokens.html) that will resolve to the final value at the time of
+deployment.
+
+## SQS
+
+Amazon Simple Queue Service (Amazon SQS) allows you to build asynchronous
+workflows. For more information about Amazon SQS, see Amazon Simple Queue
+Service. You can configure AWS Lambda to poll for these messages as they arrive
+and then pass the event to a Lambda function invocation. To view a sample event,
+see [Amazon SQS Event](https://docs.aws.amazon.com/lambda/latest/dg/eventsources.html#eventsources-sqs).
+
+To set up Amazon Simple Queue Service as an event source for AWS Lambda, you
+first create or update an Amazon SQS queue and select custom values for the
+queue parameters. The following parameters will impact Amazon SQS's polling
+behavior:
+
+* __visibilityTimeout__: May impact the period between retries.
+* __receiveMessageWaitTime__: Will determine [long
+  poll](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html)
+  duration. The default value is 20 seconds.
+* __batchSize__: Determines how many records are buffered before invoking your lambda function.
+* __maxBatchingWindow__: The maximum amount of time to gather records before invoking the lambda. This increases the likelihood of a full batch at the cost of delayed processing.
+* __enabled__: If the SQS event source mapping should be enabled. The default is true.
+
+```ts
+import { SqsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
+
+const queue = new sqs.Queue(this, 'MyQueue', {
+  visibilityTimeout: Duration.seconds(30),      // default,
+  receiveMessageWaitTime: Duration.seconds(20), // default
+});
+declare const fn: lambda.Function;
+
+fn.addEventSource(new SqsEventSource(queue, {
+  batchSize: 10, // default
+  maxBatchingWindow: Duration.minutes(5),
+  reportBatchItemFailures: true, // default to false
+}));
+```
+
+## S3
+
+You can write Lambda functions to process S3 bucket events, such as the
+object-created or object-deleted events. For example, when a user uploads a
+photo to a bucket, you might want Amazon S3 to invoke your Lambda function so
+that it reads the image and creates a thumbnail for the photo.
+
+You can use the bucket notification configuration feature in Amazon S3 to
+configure the event source mapping, identifying the bucket events that you want
+Amazon S3 to publish and which Lambda function to invoke.
+
+```ts
+import * as s3 from 'aws-cdk-lib/aws-s3';
+import { S3EventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
+
+const bucket = new s3.Bucket(this, 'mybucket');
+declare const fn: lambda.Function;
+
+fn.addEventSource(new S3EventSource(bucket, {
+  events: [ s3.EventType.OBJECT_CREATED, s3.EventType.OBJECT_REMOVED ],
+  filters: [ { prefix: 'subdir/' } ], // optional
+}));
+```
+
+## SNS
+
+You can write Lambda functions to process Amazon Simple Notification Service
+notifications. When a message is published to an Amazon SNS topic, the service
+can invoke your Lambda function by passing the message payload as a parameter.
+Your Lambda function code can then process the event, for example publish the
+message to other Amazon SNS topics, or send the message to other AWS services.
+
+This also enables you to trigger a Lambda function in response to Amazon
+CloudWatch alarms and other AWS services that use Amazon SNS.
+
+For an example event, see [Appendix: Message and JSON
+Formats](https://docs.aws.amazon.com/sns/latest/dg/json-formats.html) and
+[Amazon SNS Sample
+Event](https://docs.aws.amazon.com/lambda/latest/dg/eventsources.html#eventsources-sns).
+For an example use case, see [Using AWS Lambda with Amazon SNS from Different
+Accounts](https://docs.aws.amazon.com/lambda/latest/dg/with-sns.html).
+
+```ts
+import * as sns from 'aws-cdk-lib/aws-sns';
+import { SnsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
+
+declare const topic: sns.Topic;
+const deadLetterQueue = new sqs.Queue(this, 'deadLetterQueue');
+
+declare const fn: lambda.Function;
+fn.addEventSource(new SnsEventSource(topic, {
+  filterPolicy: { },
+  deadLetterQueue: deadLetterQueue,
+}));
+```
+
+When a user calls the SNS Publish API on a topic that your Lambda function is
+subscribed to, Amazon SNS will call Lambda to invoke your function
+asynchronously. Lambda will then return a delivery status. If there was an error
+calling Lambda, Amazon SNS will retry invoking the Lambda function up to three
+times. After three tries, if Amazon SNS still could not successfully invoke the
+Lambda function, then Amazon SNS will send a delivery status failure message to
+CloudWatch.
+
+## DynamoDB Streams
+
+You can write Lambda functions to process change events from a DynamoDB Table. An event is emitted to a DynamoDB stream (if configured) whenever a write (Put, Delete, Update)
+operation is performed against the table. See [Using AWS Lambda with Amazon DynamoDB](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html) for more information about configuring Lambda function event sources with DynamoDB.
+
+To process events with a Lambda function, first create or update a DynamoDB table and enable a `stream` specification. Then, create a `DynamoEventSource`
+and add it to your Lambda function. The following parameters will impact Amazon DynamoDB's polling behavior:
+
+* __batchSize__: Determines how many records are buffered before invoking your lambda function - could impact your function's memory usage (if too high) and ability to keep up with incoming data velocity (if too low).
+* __bisectBatchOnError__: If a batch encounters an error, this will cause the batch to be split in two and have each new smaller batch retried, allowing the records in error to be isolated.
+* __reportBatchItemFailures__: Allow functions to return partially successful responses for a batch of records.
+* __maxBatchingWindow__: The maximum amount of time to gather records before invoking the lambda. This increases the likelihood of a full batch at the cost of delayed processing.
+* __maxRecordAge__: The maximum age of a record that will be sent to the function for processing. Records that exceed the max age will be treated as failures.
+* __onFailure__: In the event a record fails after all retries or if the record age has exceeded the configured value, the record will be sent to SQS queue or SNS topic that is specified here
+* __parallelizationFactor__: The number of batches to concurrently process on each shard.
+* __retryAttempts__: The maximum number of times a record should be retried in the event of failure.
+* __startingPosition__: Will determine where to being consumption, either at the most recent ('LATEST') record or the oldest record ('TRIM_HORIZON'). 'TRIM_HORIZON' will ensure you process all available data, while 'LATEST' will ignore all records that arrived prior to attaching the event source.
+* __tumblingWindow__: The duration in seconds of a processing window when using streams.
+* __enabled__: If the DynamoDB Streams event source mapping should be enabled. The default is true.
+
+```ts
+import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
+import { DynamoEventSource, SqsDlq } from 'aws-cdk-lib/aws-lambda-event-sources';
+
+declare const table: dynamodb.Table;
+
+const deadLetterQueue = new sqs.Queue(this, 'deadLetterQueue');
+
+declare const fn: lambda.Function;
+fn.addEventSource(new DynamoEventSource(table, {
+  startingPosition: lambda.StartingPosition.TRIM_HORIZON,
+  batchSize: 5,
+  bisectBatchOnError: true,
+  onFailure: new SqsDlq(deadLetterQueue),
+  retryAttempts: 10,
+}));
+```
+
+## Kinesis
+
+You can write Lambda functions to process streaming data in Amazon Kinesis Streams. For more information about Amazon Kinesis, see [Amazon Kinesis
+Service](https://aws.amazon.com/kinesis/data-streams/). To learn more about configuring Lambda function event sources with kinesis and view a sample event,
+see [Amazon Kinesis Event](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html).
+
+To set up Amazon Kinesis as an event source for AWS Lambda, you
+first create or update an Amazon Kinesis stream and select custom values for the
+event source parameters. The following parameters will impact Amazon Kinesis's polling
+behavior:
+
+* __batchSize__: Determines how many records are buffered before invoking your lambda function - could impact your function's memory usage (if too high) and ability to keep up with incoming data velocity (if too low).
+* __bisectBatchOnError__: If a batch encounters an error, this will cause the batch to be split in two and have each new smaller batch retried, allowing the records in error to be isolated.
+* __reportBatchItemFailures__: Allow functions to return partially successful responses for a batch of records.
+* __maxBatchingWindow__: The maximum amount of time to gather records before invoking the lambda. This increases the likelihood of a full batch at the cost of possibly delaying processing.
+* __maxRecordAge__: The maximum age of a record that will be sent to the function for processing. Records that exceed the max age will be treated as failures.
+* __onFailure__: In the event a record fails and consumes all retries, the record will be sent to SQS queue or SNS topic that is specified here
+* __parallelizationFactor__: The number of batches to concurrently process on each shard.
+* __retryAttempts__: The maximum number of times a record should be retried in the event of failure.
+* __startingPosition__: Will determine where to being consumption. 'LATEST' will start at the most recent record and ignore all records that arrived prior to attaching the event source, 'TRIM_HORIZON' will start at the oldest record and ensure you process all available data, while 'AT_TIMESTAMP' will start reading records from a specified time stamp. Note that 'AT_TIMESTAMP' is only supported for Amazon Kinesis streams.
+* __startingPositionTimestamp__: The time stamp from which to start reading. Used in conjunction with __startingPosition__ when set to 'AT_TIMESTAMP'.
+* __tumblingWindow__: The duration in seconds of a processing window when using streams.
+* __enabled__: If the DynamoDB Streams event source mapping should be enabled. The default is true.
+
+```ts
+import * as kinesis from 'aws-cdk-lib/aws-kinesis';
+import { KinesisEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
+
+const stream = new kinesis.Stream(this, 'MyStream');
+
+declare const myFunction: lambda.Function;
+myFunction.addEventSource(new KinesisEventSource(stream, {
+  batchSize: 100, // default
+  startingPosition: lambda.StartingPosition.TRIM_HORIZON,
+}));
+```
+
+## Kafka
+
+You can write Lambda functions to process data either from [Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) or a [self managed Kafka](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) cluster.
+
+The following code sets up Amazon MSK as an event source for a lambda function. Credentials will need to be configured to access the
+MSK cluster, as described in [Username/Password authentication](https://docs.aws.amazon.com/msk/latest/developerguide/msk-password.html).
+
+```ts
+import { Secret } from 'aws-cdk-lib/aws-secretsmanager';
+import { ManagedKafkaEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
+
+// Your MSK cluster arn
+const clusterArn = 'arn:aws:kafka:us-east-1:0123456789019:cluster/SalesCluster/abcd1234-abcd-cafe-abab-9876543210ab-4';
+
+// The Kafka topic you want to subscribe to
+const topic = 'some-cool-topic';
+
+// The secret that allows access to your MSK cluster
+// You still have to make sure that it is associated with your cluster as described in the documentation
+const secret = new Secret(this, 'Secret', { secretName: 'AmazonMSK_KafkaSecret' });
+
+declare const myFunction: lambda.Function;
+myFunction.addEventSource(new ManagedKafkaEventSource({
+  clusterArn,
+  topic: topic,
+  secret: secret,
+  batchSize: 100, // default
+  startingPosition: lambda.StartingPosition.TRIM_HORIZON,
+}));
+```
+
+The following code sets up a self managed Kafka cluster as an event source. Username and password based authentication
+will need to be set up as described in [Managing access and permissions](https://docs.aws.amazon.com/lambda/latest/dg/smaa-permissions.html#smaa-permissions-add-secret).
+
+```ts
+import { Secret } from 'aws-cdk-lib/aws-secretsmanager';
+import { SelfManagedKafkaEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
+
+// The list of Kafka brokers
+const bootstrapServers = ['kafka-broker:9092'];
+
+// The Kafka topic you want to subscribe to
+const topic = 'some-cool-topic';
+
+// The secret that allows access to your self hosted Kafka cluster
+declare const secret: Secret;
+
+// (Optional) The secret containing the root CA certificate that your Kafka brokers use for TLS encryption
+declare const encryption: Secret;
+
+// (Optional) The consumer group id to use when connecting to the Kafka broker. If omitted the UUID of the event source mapping will be used.
+const consumerGroupId: "my-consumer-group-id";
+
+declare const myFunction: lambda.Function;
+myFunction.addEventSource(new SelfManagedKafkaEventSource({
+  bootstrapServers: bootstrapServers,
+  topic: topic,
+  consumerGroupId: consumerGroupId,
+  secret: secret,
+  batchSize: 100, // default
+  startingPosition: lambda.StartingPosition.TRIM_HORIZON,
+  encryption: encryption // optional
+}));
+```
+
+If your self managed Kafka cluster is only reachable via VPC also configure `vpc` `vpcSubnets` and `securityGroup`.
+
+## Roadmap
+
+Eventually, this module will support all the event sources described under
+[Supported Event
+Sources](https://docs.aws.amazon.com/lambda/latest/dg/invoking-lambda-function.html)
+in the AWS Lambda Developer Guide.