Skip to content

armgit / floci

Public Imported from GitHub
0

Light, fluffy, and always free - The AWS Local Emulator alternative

docs(pipes): add documentation and navigation for EventBridge Pipes (#1001)

Sidbe01ee07476a
diff --git a/README.md b/README.md
index bfb96d73ec..fda608ce10 100644
--- a/README.md
+++ b/README.md
@@ -166,7 +166,7 @@ LocalStack's community edition [sunset in March 2026](https://blog.localstack.cl
| CodeBuild | Real Docker execution | No |
| Native binary | ~40 MB | No |
-**51 AWS services. Broad coverage. Free forever.**
+**52 AWS services. Broad coverage. Free forever.**
## Architecture Overview
@@ -208,7 +208,7 @@ Floci supports local emulation for application services, data services, eventing
| Category | Services |
|---|---|
| Core app services | S3, SQS, SNS, DynamoDB, Lambda, IAM, STS, KMS, Secrets Manager |
-| Events and workflows | EventBridge, EventBridge Scheduler, Step Functions, CloudWatch Logs, CloudWatch Metrics |
+| Events and workflows | EventBridge, EventBridge Pipes, EventBridge Scheduler, Step Functions, CloudWatch Logs, CloudWatch Metrics |
| API and identity | API Gateway REST, API Gateway v2, Cognito, ACM, Route53 |
| Containers and compute | ECS, EC2, EKS, CodeBuild, CodeDeploy, Auto Scaling, ELB v2 |
| Graph database | Neptune |
@@ -243,6 +243,7 @@ For operation-level compatibility, see the [Services Overview](https://floci.io/
| Step Functions | In-process | ASL execution, task tokens, execution history |
| CloudFormation | In-process | Stacks, change sets, resource provisioning |
| EventBridge | In-process | Custom buses, rules, SQS, SNS and Lambda targets |
+| EventBridge Pipes | In-process | Poller-based integration connecting SQS, Kinesis, DynamoDB, and MSK sources to targets with optional filtering |
| EventBridge Scheduler | In-process | Schedule groups, schedules, flexible time windows, retry policies, DLQs |
| CloudWatch Logs | In-process | Log groups, streams, ingestion, filtering |
| CloudWatch Metrics | In-process | Custom metrics, statistics, alarms |
diff --git a/docs/services/pipes.md b/docs/services/pipes.md
new file mode 100644
index 0000000000..f1e96ce653
--- /dev/null
+++ b/docs/services/pipes.md
@@ -0,0 +1,91 @@
+# EventBridge Pipes
+
+**Protocol:** REST-JSON
+**Endpoint:** `POST http://localhost:4566/`
+
+## Supported Actions
+
+| Action | Description |
+|---|---|
+| `CreatePipe` | Create a new pipe with source, target, and optional enrichment |
+| `DescribePipe` | Get pipe details including state and configuration |
+| `UpdatePipe` | Update pipe configuration (source, target, role, enrichment, desired state) |
+| `DeletePipe` | Delete a pipe |
+| `ListPipes` | List all pipes with optional filtering by state and prefix |
+| `StartPipe` | Start a stopped pipe |
+| `StopPipe` | Stop a running pipe |
+
+## Configuration
+
+| Variable | Default | Description |
+|---|---|---|
+| `FLOCI_SERVICES_PIPES_ENABLED` | `true` | Enable or disable the service |
+
+## Examples
+
+```bash
+export AWS_ENDPOINT_URL=http://localhost:4566
+
+# Create a pipe (SQS to Lambda)
+aws pipes create-pipe \
+ --name my-pipe \
+ --source "arn:aws:sqs:us-east-1:000000000000:source-queue" \
+ --target "arn:aws:lambda:us-east-1:000000000000:function:my-function" \
+ --role-arn "arn:aws:iam::000000000000:role/pipe-role" \
+ --endpoint-url $AWS_ENDPOINT_URL
+
+# Describe a pipe
+aws pipes describe-pipe \
+ --name my-pipe \
+ --endpoint-url $AWS_ENDPOINT_URL
+
+# List all pipes
+aws pipes list-pipes \
+ --endpoint-url $AWS_ENDPOINT_URL
+
+# Start a pipe
+aws pipes start-pipe \
+ --name my-pipe \
+ --endpoint-url $AWS_ENDPOINT_URL
+
+# Stop a pipe
+aws pipes stop-pipe \
+ --name my-pipe \
+ --endpoint-url $AWS_ENDPOINT_URL
+
+# Update a pipe
+aws pipes update-pipe \
+ --name my-pipe \
+ --target "arn:aws:lambda:us-east-1:000000000000:function:new-function" \
+ --endpoint-url $AWS_ENDPOINT_URL
+
+# Delete a pipe
+aws pipes delete-pipe \
+ --name my-pipe \
+ --endpoint-url $AWS_ENDPOINT_URL
+```
+
+## Pipe States
+
+- `STARTING` - Pipe is being started
+- `RUNNING` - Pipe is actively processing events
+- `STOPPING` - Pipe is being stopped
+- `STOPPED` - Pipe is stopped and not processing events
+- `DELETED` - Pipe has been deleted
+
+## Supported Sources and Targets
+
+Floci emulates EventBridge Pipes with the following supported source and target types:
+
+**Sources:**
+- Amazon SQS queues
+- Amazon Kinesis streams
+- Amazon DynamoDB streams
+- Kafka topics (MSK)
+
+**Targets:**
+- Lambda functions
+- SQS queues
+- SNS topics
+- Kinesis streams
+- Step Functions state machines
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index 99070a51ff..143600d949 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -96,6 +96,7 @@ nav:
- Athena: services/athena.md
- Data Firehose: services/firehose.md
- EventBridge: services/eventbridge.md
+ - EventBridge Pipes: services/pipes.md
- EventBridge Scheduler: services/scheduler.md
- CloudWatch: services/cloudwatch.md
- ACM: services/acm.md