Merge pull request #5 from distinction-dev/docs-refactor

Docs refactor
distinction-dev · Aug 1, 2023 · e865094 · e865094
2 parents 6cefac9 + bca0298
commit e865094
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 3 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -48,17 +48,20 @@ functions:
         handler: functions/pipeEnricher.handler
 
 pipes:
-  testPipe: #pipesName
+ testPipe: #pipeName
+    enabled: true
     source:
       sqs:
         arn:
           Fn::GetAtt: [SourceSQSQueue, Arn]
     target:
-      sqs:
+      sns:
         arn:
           Fn::GetAtt: [TargetSNSTopic, TopicArn]
     enrichment: 
       name: pipeEnricher
+    filter:
+      - Pattern: "{ \"body\": { \"message\": [ \"hello\" ], \"city\": [ \"hey\" ] }}"
     iamRolePipes:
       type: "individual"
 

diff --git a/docs/parameters/EnabledParameter.md b/docs/parameters/EnabledParameter.md
@@ -0,0 +1,27 @@
+[@distinction-dev/serverless-pipes](../README.md) / [Exports](parameters.md) / EnabledParameter
+
+# Usage
+```yaml
+
+# serverless.yml
+
+pipes:
+  pipeName:
+    enabled: true
+```
+
+
+### enabled
+
+
+It defines the `DesiredState` of EventBridge Pipes. If set to true sets the `DesiredState` property to `RUNNING` else sets to `STOPPED`.
+
+
+#### Defined in
+
+[schema.ts:272](https://github.com/distinction-dev/serverless-pipes/blob/6cefac9dfc5db878e76fb245dec34bbf0da88b5d/src/schema.ts#L272)
+
+
+
+
+---
diff --git a/test-service/serverless.yml b/test-service/serverless.yml
@@ -1,4 +1,4 @@
-service: test-service
+service: serverless-pipes-plugin
 frameworkVersion: '^3.28.1'
 useDotenv: true