@@ -8,36 +8,36 @@ import Image from "@theme/IdealImage";
88
99# Live events setup
1010
11- Port's AWS integration supports real-time event processing, allowing for accurate real-time representation of your AWS infrastructure inside Port. This guide explains how to set up live events for your AWS resources.
11+ Port's AWS integration supports real-time event processing, allowing for accurate representation of your AWS infrastructure inside Port. This guide explains how to set up live events for your AWS resources.
1212
1313:::info Current Limitations
1414Live events are currently only available for:
1515- ** Single account installations** (not multi-account).
1616- ** Default Terraform installation** with support for three resource types by default:
17- - EC2 Instances.
18- - S3 Buckets.
19- - CloudFormation Stacks.
17+ - ` EC2 Instances ` .
18+ - ` S3 Buckets ` .
19+ - ` CloudFormation Stacks ` .
2020:::
2121
2222## Prerequisites
2323
2424Before setting up live events, ensure you have:
2525
26- - ** AWS Integration Installed ** : Complete the [ AWS integration installation] ( ./installation.md ) .
27- - ** API Gateway Setup ** : The integration requires an API Gateway endpoint (automatically created with Terraform installation).
28- - ** Port API Key ** : Your Port API key for authentication.
29- - ** AWS Permissions ** : Ability to create EventBridge rules in your AWS account.
26+ - ** AWS integration installed ** : Complete the [ AWS integration installation] ( ./installation.md ) .
27+ - ** API Gateway setup ** : The integration requires an API Gateway endpoint (automatically created with Terraform installation).
28+ - ** Port API key ** : Your Port API key for authentication.
29+ - ** AWS permissions ** : Ability to create EventBridge rules in your AWS account.
3030
3131:::tip Terraform vs Manual Installation
32- - ** Terraform users** : Use the provided Terraform module for automated setup
33- - ** Manual installation users** : Follow the AWS console setup steps
32+ - ** Terraform users** : Use the provided Terraform module for automated setup.
33+ - ** Manual installation users** : Follow the AWS console setup steps.
3434:::
3535
3636## How live events work
3737
3838<img src =' /img/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/live-events-diagram.svg ' width =' 50% ' border =' 1px ' />
3939
40- Live events work by :
40+ The live events flow follows these steps :
4141
42421 . ** AWS Services** generate events when resources change.
43432 . ** CloudTrail** captures these events.
@@ -64,6 +64,9 @@ The default Terraform module supports live events for these resource types:
6464
6565To add live events for additional resource types (like SSM Parameters), use the ` aws_event_rule ` module:
6666
67+ <details >
68+ <summary ><b >AWS event rule module (click to expand)</b ></summary >
69+
6770``` hcl showLineNumbers
6871module "aws_event_rule" {
6972 source = "port-labs/integration-factory/ocean//modules/aws_helpers/event"
@@ -88,8 +91,10 @@ module "aws_event_rule" {
8891 target_arn = "<api_gateway_arn>/production/POST/integration/webhook"
8992}
9093```
94+ </details >
9195
92- <h3 >Configuration parameters</h3 >
96+ <details >
97+ <summary ><b >Configuration parameters (click to expand)</b ></summary >
9398
9499| Parameter | Description | Example |
95100| -----------| -------------| ---------|
@@ -100,33 +105,35 @@ module "aws_event_rule" {
100105| ` api_key_param ` | Port API key parameter | ` "<live_events_api_key>" ` |
101106| ` target_arn ` | API Gateway target ARN | ` "<api_gateway_arn>/production/POST/integration/webhook" ` |
102107
108+ </details >
109+
103110</TabItem >
104111<TabItem value =" manual " label =" Manual AWS Console Setup " >
105112
106113If you installed the AWS integration manually, follow these steps to create EventBridge rules in the AWS console.
107114
108115<h3 >Step 1: Create a rule</h3 >
109116
110- 1 . Go to ** EventBridge** → ** Rules** → ** Create rule**
111- 2 . ** Rule name** : Give it a descriptive name (e.g., ` port-live-updates-ssm ` )
112- 3 . Click ** Next**
117+ 1 . Go to ** EventBridge** → ** Rules** → ** Create rule** .
118+ 2 . ** Rule name** : Give it a descriptive name (e.g., ` port-live-updates-ssm ` ).
119+ 3 . Click ** Next** .
113120
114121<h3 >Step 2: Define the event pattern</h3 >
115122
116- 1 . ** Event source** : Select "AWS events or services"
117- 2 . ** Event service** : Select the relevant AWS service (e.g., "Systems Manager")
118- 3 . ** Event type** : Select the type of event (e.g., "Parameter Store")
119- 4 . ** Event Type Specification** : Select "Specific detail type(s)" and choose the event type (e.g., "Parameter Store Change")
120- 5 . Click ** Next**
123+ 1 . ** Event source** : Select "AWS events or services".
124+ 2 . ** Event service** : Select the relevant AWS service (e.g., "Systems Manager").
125+ 3 . ** Event type** : Select the type of event (e.g., "Parameter Store").
126+ 4 . ** Event Type Specification** : Select "Specific detail type(s)" and choose the event type (e.g., "Parameter Store Change").
127+ 5 . Click ** Next** .
121128
122129<h3 >Step 3: Configure the target</h3 >
123130
124- 1 . ** Target type** : Select "AWS Service"
125- 2 . ** Target** : Select "API Gateway"
126- 3 . ** Target location** : Select "Target in this account"
127- 4 . ** API** : Select the API Gateway created for your integration
128- 5 . ** Deployment stage** : Select "production"
129- 6 . ** Integration target** : Enter ` /integration/webhook ` (HTTP POST)
131+ 1 . ** Target type** : Select "AWS Service".
132+ 2 . ** Target** : Select "API Gateway".
133+ 3 . ** Target location** : Select "Target in this account".
134+ 4 . ** API** : Select the API Gateway created for your integration.
135+ 5 . ** Deployment stage** : Select "production".
136+ 6 . ** Integration target** : Enter ` /integration/webhook ` (HTTP POST).
130137
131138<h3 >Step 4: Add required headers</h3 >
132139
@@ -171,8 +178,8 @@ Replace `"AWS::SSM::Parameter"` with the appropriate AWS resource type:
171178
172179<h3 >Step 6: Review & Create</h3 >
173180
174- 1 . Click ** Next** → ** Next** → ** Create rule**
175- 2 . AWS will now forward matching events to Port automatically
181+ 1 . Click ** Next** → ** Next** → ** Create rule** .
182+ 2 . AWS will now forward matching events to Port automatically.
176183
177184</TabItem >
178185</Tabs >
@@ -183,20 +190,20 @@ Replace `"AWS::SSM::Parameter"` with the appropriate AWS resource type:
183190
184191If you have other live event rules (e.g., S3 Bucket sync), verify they're working:
185192
186- 1 . Go to ** EventBridge** → ** Rules**
187- 2 . Check that your rules are ** Enabled**
188- 3 . Look for any recent invocations in the ** Metrics** tab
193+ 1 . Go to ** EventBridge** → ** Rules** .
194+ 2 . Check that your rules are ** Enabled** .
195+ 3 . Look for any recent invocations in the ** Metrics** tab.
189196
190197### Test live events
191198
1921991 . ** Trigger a test event** :
193- - Modify/create a resource (e.g., create an SSM Parameter)
194- - Update an existing resource
195- - Delete a resource
200+ - Modify/create a resource (e.g., create an SSM Parameter).
201+ - Update an existing resource.
202+ - Delete a resource.
196203
1972042 . ** Verify in Port** :
198- - Check your software catalog for real-time updates
199- - Look for the resource changes in Port's interface
205+ - Check your software catalog for real-time updates.
206+ - Look for the resource changes in Port's interface.
200207
201208### Example test for SSM parameters
202209
@@ -205,7 +212,7 @@ If you have other live event rules (e.g., S3 Bucket sync), verify they're workin
205212 - Name: ` /test/my-parameter `
206213 - Type: ` String `
207214 - Value: ` test-value `
208- 3 . Check Port for the new parameter entity
215+ 3 . Check Port for the new parameter entity.
209216
210217## Troubleshooting
211218
@@ -261,9 +268,9 @@ To add live events for additional AWS services, follow the same pattern:
261268
262269After setting up live events:
263270
264- 1 . ** Monitor Performance** : Keep an eye on EventBridge metrics and API Gateway logs
265- 2 . ** Scale as Needed** : Add more resource types as your requirements grow
266- 3 . ** Optimize Patterns** : Fine-tune event patterns to reduce noise and improve performance
271+ 1 . ** Monitor Performance** : Keep an eye on EventBridge metrics and API Gateway logs.
272+ 2 . ** Scale as Needed** : Add more resource types as your requirements grow.
273+ 3 . ** Optimize Patterns** : Fine-tune event patterns to reduce noise and improve performance.
267274
268275For more advanced configuration options, see the [ AWS integration examples] ( ../examples/examples.md ) .
269276
0 commit comments