Skip to content

Commit 37da027

Browse files
committed
revamp pipes
1 parent 9752e70 commit 37da027

File tree

1 file changed

+24
-27
lines changed

1 file changed

+24
-27
lines changed

src/content/docs/aws/services/pipes.md

Lines changed: 24 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: "EventBridge Pipes"
3-
linkTitle: "EventBridge Pipes"
43
description: Get started with EventBridge Pipes on LocalStack
54
tags: ["Free"]
65
persistence: supported with limitations
@@ -16,12 +15,12 @@ In contrast, EventBridge Event Bus offers a one-to-many integration where an eve
1615
LocalStack allows you to use the Pipes APIs in your local environment to create Pipes with SQS queues and Kinesis streams as source and target.
1716
You can also filter events using EventBridge event patterns and enrich events using Lambda.
1817

19-
The supported APIs are available on our [API coverage page]({{< ref "coverage_pipes" >}}), which provides information on the extent of Pipe's integration with LocalStack.
18+
The supported APIs are available on our [API coverage page](), which provides information on the extent of Pipe's integration with LocalStack.
2019

21-
{{< callout >}}
20+
:::note
2221
The implementation of EventBridge Pipes is currently in **preview** stage and under active development.
2322
If you would like support for more APIs or report bugs, please make an issue on [GitHub](https://github.com/localstack/localstack/issues/new/choose).
24-
{{< /callout >}}
23+
:::
2524

2625
## Getting started
2726

@@ -35,29 +34,29 @@ We will demonstrate how to create a Pipe with SQS queues as source and target, a
3534
Create two SQS queues that will be used as source and target for the Pipe.
3635
Run the following command to create a queue using the [`CreateQueue`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) API:
3736

38-
{{< command >}}
39-
$ awslocal sqs create-queue --queue-name source-queue
40-
$ awslocal sqs create-queue --queue-name target-queue
41-
{{< /command >}}
37+
```bash
38+
awslocal sqs create-queue --queue-name source-queue
39+
awslocal sqs create-queue --queue-name target-queue
40+
```
4241

4342
You can fetch their queue ARNs using the [`GetQueueAttributes`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueAttributes.html) API:
4443

45-
{{< command >}}
46-
$ SOURCE_QUEUE_ARN=$(awslocal sqs get-queue-attributes --queue-url http://sqs.us-east-1.localhost.localstack.cloud:4566/000000000000/source-queue --attribute-names QueueArn --output text)
47-
$ TARGET_QUEUE_ARN=$(awslocal sqs get-queue-attributes --queue-url http://sqs.us-east-1.localhost.localstack.cloud:4566/000000000000/target-queue --attribute-names QueueArn --output text)
48-
{{< /command >}}
44+
```bash
45+
SOURCE_QUEUE_ARN=$(awslocal sqs get-queue-attributes --queue-url http://sqs.us-east-1.localhost.localstack.cloud:4566/000000000000/source-queue --attribute-names QueueArn --output text)
46+
TARGET_QUEUE_ARN=$(awslocal sqs get-queue-attributes --queue-url http://sqs.us-east-1.localhost.localstack.cloud:4566/000000000000/target-queue --attribute-names QueueArn --output text)
47+
```
4948

5049
### Create a Pipe
5150

5251
You can now create a Pipe, using the [`CreatePipe`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreatePipe.html) API.
5352
Run the following command, by specifying the source and target queue ARNs we created earlier:
5453

55-
{{< command >}}
56-
$ awslocal pipes create-pipe --name sample-pipe \
54+
```bash
55+
awslocal pipes create-pipe --name sample-pipe \
5756
--source $SOURCE_QUEUE_ARN \
5857
--target $TARGET_QUEUE_ARN \
5958
--role-arn arn:aws:iam::000000000000:role/pipes-role
60-
{{< /command >}}
59+
```
6160

6261
The following output would be retrieved:
6362

@@ -76,9 +75,9 @@ The following output would be retrieved:
7675

7776
You can use the [`DescribePipe`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribePipe.html) API to get information about the Pipe:
7877

79-
{{< command >}}
80-
$ awslocal pipes describe-pipe --name sample-pipe
81-
{{< /command >}}
78+
```bash
79+
awslocal pipes describe-pipe --name sample-pipe
80+
```
8281

8382
The following output would be retrieved:
8483

@@ -110,29 +109,27 @@ The following output would be retrieved:
110109
You can now send events to the source queue, which will be routed to the target queue.
111110
Run the following command to send an event to the source queue:
112111

113-
{{< command >}}
114-
$ awslocal sqs send-message \
112+
```bash
113+
awslocal sqs send-message \
115114
--queue-url http://sqs.us-east-1.localhost.localstack.cloud:4566/000000000000/source-queue \
116115
--message-body "message-1"
117-
{{< /command >}}
116+
```
118117

119118
### Receive events from the target queue
120119

121120
You can fetch the message from the target queue using the [`ReceiveMessage`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ReceiveMessage.html) API:
122121

123-
{{< command >}}
124-
$ awslocal sqs receive-message \
122+
```bash
123+
awslocal sqs receive-message \
125124
--queue-url http://sqs.us-east-1.localhost.localstack.cloud:4566/000000000000/target-queue
126-
{{< /command >}}
125+
```
127126

128127
## Resource Browser
129128

130129
The LocalStack Web Application provides a Resource Browser for managing EventBridge Pipes.
131130
You can access the Resource Browser by opening the LocalStack Web Application in your browser, navigating to the **Resource Browser** section, and then clicking on **EventBridge Pipes** under the **App Integration** section.
132131

133-
<img src="pipes-resource-browser.png" alt="EventBridge Pipes Resource Browser" title="EventBridge Pipes Resource Browser" width="900" />
134-
<br>
135-
<br>
132+
![EventBridge Pipes Resource Browser](/images/aws/pipes-resource-browser.png)
136133

137134
The Resource Browser for EventBridge Pipes in LocalStack allows you to perform the following actions:
138135

0 commit comments

Comments
 (0)