"
+ - __Issues__: Indicate issues fixed via: "**Fixes #xxx**" or "**Closes #xxx**"
+
+Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
+
+1. You are working against the latest source on the *main* branch.
+
+---
+### Step 1: Open Issue
+
+If there isn't one already, open an issue describing what you intend to contribute. It's useful to communicate in advance, because sometimes, someone is already working in this space, so maybe it's worth collaborating with them instead of duplicating the efforts.
+
+### Step 2: Fork the repository
+GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/). Make sure you are working against the latest source on the *main* branch.
+
+### Step 3: Develop
+
+This repository use [pre-commit](https://pre-commit.com/) hooks for linting and [projen](https://github.com/projen/projen) for building and testing
+
+1. Follow the [quickstart guide](https://pre-commit.com/#quick-start) for `pre-commit` (skipping step #2)
+2. Change code
+3. If relevant, add [tests](test\ServerlessClamscan.test.ts)
+4. Run tests
+ * `npx projen test`
+5. Build
+ * `npx projen build`
+6. Update relevant documentation
+7. Create the commit and update files based on `pre-commit` findings
+
+
+### Step 4: Make the pull request
+
+Send us a [pull request](https://help.github.com/articles/creating-a-pull-request/), answering any default questions in the pull request interface. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+
+
+## Finding contributions to work on
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
+
+
+## Code of Conduct
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
+opensource-codeofconduct@amazon.com with any additional questions or comments.
+
+
+## Security issue notifications
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
+
+
+## Licensing
+
+See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
diff --git a/LICENSE b/LICENSE
index 67db8588..beac340d 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,4 +1,3 @@
-
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
@@ -173,3 +172,30 @@
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright 2021 Amazon Web Services
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/NOTICE b/NOTICE
index 616fc588..ebb2057a 100644
--- a/NOTICE
+++ b/NOTICE
@@ -1 +1,2 @@
-Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+cdk-serverless-clamscan
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
\ No newline at end of file
diff --git a/README.md b/README.md
index 847260ca..48ea561c 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,172 @@
-## My Project
+# cdk-serverless-clamscan
-TODO: Fill this README out!
+[](https://pypi.org/project/cdk-serverless-clamscan/)
+[](https://www.npmjs.com/package/cdk-serverless-clamscan)
-Be sure to:
+An [aws-cdk](https://github.com/aws/aws-cdk) construct that uses [ClamAV®](https://www.clamav.net/) to scan objects in Amazon S3 for viruses. The construct provides a flexible interface for a system to act based on the results of a ClamAV virus scan.
-* Change the title in this README
-* Edit your repository description on GitHub
+
-## Security
-See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+## Pre-Requisites
-## License
+**Docker:** The ClamAV Lambda functions utilizes a [container image](https://aws.amazon.com/blogs/aws/new-for-aws-lambda-container-image-support/) that is built locally using [docker bundling](https://aws.amazon.com/blogs/devops/building-apps-with-aws-cdk/)
+
+## Examples
+
+This project uses [projen](https://github.com/projen/projen) and thus all the constructs follow language specific standards and naming patterns. For more information on how to translate the following examples into your desired language read the CDK guide on [Translating TypeScript AWS CDK code to other languages](https://docs.aws.amazon.com/cdk/latest/guide/multiple_languages.html)
+
+### Example 1. (Default destinations with rule target)
+
+typescript
+
+
+```typescript
+import { RuleTargetInput } from '@aws-cdk/aws-events';
+import { SnsTopic } from '@aws-cdk/aws-events-targets';
+import { Bucket } from '@aws-cdk/aws-s3';
+import { Topic } from '@aws-cdk/aws-sns';
+import { Construct, Stack, StackProps } from '@aws-cdk/core';
+import { ServerlessClamscan } from '@donti/cdk-serverless-clamscan';
+
+export class CdkTestStack extends Stack {
+ constructor(scope: Construct, id: string, props?: StackProps) {
+ super(scope, id, props);
+
+ const bucket_1 = new Bucket(this, 'rBucket1');
+ const bucket_2 = new Bucket(this, 'rBucket2');
+ const bucketList = [bucket_1, bucket_2];
+ const sc = new ServerlessClamscan(this, 'rClamscan', {
+ buckets: bucketList,
+ });
+ const bucket_3 = new Bucket(this, 'rBucket3');
+ sc.addSourceBucket(bucket_3);
+ const infectedTopic = new Topic(this, 'rInfectedTopic')
+ sc.infectedRule?.addTarget(new SnsTopic(infectedTopic, {
+ message: RuleTargetInput.fromEventPath('$.detail.responsePayload.message')
+ }))
+ }
+}
+```
+
+python
+
+
+```python
+from aws_cdk import (
+ core as core,
+ aws_events as events,
+ aws_events_targets as events_targets,
+ aws_s3 as s3,
+ aws_sns as sns
+)
+from cdk_serverless_clamscan import ServerlessClamscan
+
+class CdkTestStack(core.Stack):
+
+ def __init__(self, scope: core.Construct, construct_id: str, **kwargs) -> None:
+ super().__init__(scope, construct_id, **kwargs)
+
+ bucket_1 = s3.Bucket(self, "rBucket1")
+ bucket_2 = s3.Bucket(self, "rBucket2")
+ bucketList = [ bucket_1, bucket_2 ]
+ sc = ServerlessClamscan(self, "rClamScan",
+ buckets=bucketList,
+ )
+ bucket_3 = s3.Bucket(self, "rBucket3")
+ sc.add_source_bucket(bucket_3)
+ infected_topic = sns.Topic(self, "rInfectedTopic")
+ if sc.infected_rule != None:
+ sc.infected_rule.add_target(
+ events_targets.SnsTopic(
+ infected_topic,
+ message=events.RuleTargetInput.from_event_path('$.detail.responsePayload.message'),
+ )
+ )
+```
+
+typescript
+
+
+```typescript
+import { SqsDestination, EventBridgeDestination } from '@aws-cdk/aws-lambda-destinations';
+import { Bucket } from '@aws-cdk/aws-s3';
+import { Queue } from '@aws-cdk/aws-sqs';
+import { Construct, Stack, StackProps } from '@aws-cdk/core';
+import { ServerlessClamscan } from '@donti/cdk-serverless-clamscan';
-This project is licensed under the Apache-2.0 License.
+export class CdkTestStack extends Stack {
+ constructor(scope: Construct, id: string, props?: StackProps) {
+ super(scope, id, props);
+
+ const bucket_1 = new Bucket(this, 'rBucket1');
+ const bucket_2 = new Bucket(this, 'rBucket2');
+ const bucketList = [bucket_1, bucket_2];
+ const queue = new Queue(this, 'rQueue');
+ const sc = new ServerlessClamscan(this, 'default', {
+ buckets: bucketList,
+ onResult: new EventBridgeDestination(),
+ onError: new SqsDestination(queue),
+ });
+ const bucket_3 = new Bucket(this, 'rBucket3');
+ sc.addSourceBucket(bucket_3);
+ }
+}
+```
+
+python
+
+
+```python
+from aws_cdk import (
+ core as core,
+ aws_lambda_destinations as lambda_destinations,
+ aws_s3 as s3,
+ aws_sqs as sqs
+)
+from cdk_serverless_clamscan import ServerlessClamscan
+
+class CdkTestStack(core.Stack):
+
+ def __init__(self, scope: core.Construct, construct_id: str, **kwargs) -> None:
+ super().__init__(scope, construct_id, **kwargs)
+
+ bucket_1 = s3.Bucket(self, "rBucket1")
+ bucket_2 = s3.Bucket(self, "rBucket2")
+ bucketList = [ bucket_1, bucket_2 ]
+ queue = sqs.Queue(self, "rQueue")
+ sc = ServerlessClamscan(self, "rClamScan",
+ buckets=bucketList,
+ on_result=lambda_destinations.EventBridgeDestination(),
+ on_error=lambda_destinations.SqsDestination(queue),
+ )
+ bucket_3 = s3.Bucket(self, "rBucket3")
+ sc.add_source_bucket(bucket_3)
+```
+
+