@@ -6,65 +6,65 @@ import Tabs from "@theme/Tabs";
66import TabItem from "@theme/TabItem ";
77import Image from "@theme/IdealImage ";
88
9- # Live Events Setup
9+ # Live events setup
1010
1111Port'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.
1212
1313:::info Current Limitations
1414Live events are currently only available for:
15- - ** Single account installations** (not multi-account)
16- - ** Default Terraform installation** with support for 3 resource types by default:
17- - EC2 Instances
18- - S3 Buckets
19- - CloudFormation Stacks
15+ - ** Single account installations** (not multi-account).
16+ - ** Default Terraform installation** with support for three resource types by default:
17+ - EC2 Instances.
18+ - S3 Buckets.
19+ - CloudFormation Stacks.
2020:::
2121
2222## Prerequisites
2323
2424Before setting up live events, ensure you have:
2525
26- 1 . ** AWS Integration Installed** : Complete the [ AWS integration installation] ( ./installation.md ) first
27- 2 . ** API Gateway Setup** : The integration requires an API Gateway endpoint (automatically created with Terraform installation)
28- 3 . ** Port API Key** : Your Port API key for authentication
29- 4 . ** 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
3232- ** Terraform users** : Use the provided Terraform module for automated setup
3333- ** Manual installation users** : Follow the AWS console setup steps
3434:::
3535
36- ## How Live Events Work
36+ ## How live events work
3737
38- <Image img={require("../../../static/ img/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/live-events-diagram.svg")} />
38+ <img src = ' / img/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/live-events-diagram.svg' width = ' 50% ' border = ' 1px ' />
3939
4040Live events work by:
4141
42- 1 . ** AWS Services** generate events when resources change
43- 2 . ** CloudTrail** captures these events
44- 3 . ** EventBridge Rules** filter and route specific events
45- 4 . ** API Gateway** receives the events and forwards them to Port
46- 5 . ** Port Integration** processes the events and updates your software catalog
42+ 1 . ** AWS Services** generate events when resources change.
43+ 2 . ** CloudTrail** captures these events.
44+ 3 . ** EventBridge Rules** filter and route specific events.
45+ 4 . ** API Gateway** receives the events and forwards them to Port.
46+ 5 . ** Port Integration** processes the events and updates your software catalog.
4747
48- ## Setup Methods
48+ ## Setup methods
4949
5050<Tabs >
5151<TabItem value =" terraform " label =" Terraform (Recommended) " default >
5252
5353If you installed the AWS integration using Terraform, use the provided module to set up live events.
5454
55- ### Supported Resource Types
55+ < h3 > Supported resource types</ h3 >
5656
5757The default Terraform module supports live events for these resource types:
5858
5959- ** EC2 Instances** (` AWS::EC2::Instance ` )
6060- ** S3 Buckets** (` AWS::S3::Bucket ` )
6161- ** CloudFormation Stacks** (` AWS::CloudFormation::Stack ` )
6262
63- ### Adding Custom Resource Types
63+ < h3 > Adding custom resource types</ h3 >
6464
6565To add live events for additional resource types (like SSM Parameters), use the ` aws_event_rule ` module:
6666
67- ``` hcl
67+ ``` hcl showLineNumbers
6868module "aws_event_rule" {
6969 source = "port-labs/integration-factory/ocean//modules/aws_helpers/event"
7070
@@ -89,7 +89,7 @@ module "aws_event_rule" {
8989}
9090```
9191
92- ### Configuration Parameters
92+ < h3 > Configuration parameters</ h3 >
9393
9494| Parameter | Description | Example |
9595| -----------| -------------| ---------|
@@ -105,21 +105,21 @@ module "aws_event_rule" {
105105
106106If you installed the AWS integration manually, follow these steps to create EventBridge rules in the AWS console.
107107
108- ### Step 1: Create a Rule
108+ < h3 > Step 1: Create a rule</ h3 >
109109
1101101 . Go to ** EventBridge** → ** Rules** → ** Create rule**
1111112 . ** Rule name** : Give it a descriptive name (e.g., ` port-live-updates-ssm ` )
1121123 . Click ** Next**
113113
114- ### Step 2: Define the Event Pattern
114+ < h3 > Step 2: Define the event pattern</ h3 >
115115
1161161 . ** Event source** : Select "AWS events or services"
1171172 . ** Event service** : Select the relevant AWS service (e.g., "Systems Manager")
1181183 . ** Event type** : Select the type of event (e.g., "Parameter Store")
1191194 . ** Event Type Specification** : Select "Specific detail type(s)" and choose the event type (e.g., "Parameter Store Change")
1201205 . Click ** Next**
121121
122- ### Step 3: Configure the Target
122+ < h3 > Step 3: Configure the target</ h3 >
123123
1241241 . ** Target type** : Select "AWS Service"
1251252 . ** Target** : Select "API Gateway"
@@ -128,7 +128,7 @@ If you installed the AWS integration manually, follow these steps to create Even
1281285 . ** Deployment stage** : Select "production"
1291296 . ** Integration target** : Enter ` /integration/webhook ` (HTTP POST)
130130
131- ### Step 4: Add Required Headers
131+ < h3 > Step 4: Add required headers</ h3 >
132132
133133Add these required headers:
134134
@@ -137,12 +137,12 @@ Add these required headers:
137137| ` Content-Type ` | ` application/json ` |
138138| ` x-port-aws-ocean-api-key ` | ` <your-api-key> ` (replace with actual key) |
139139
140- ### Step 5: Transform the Event Data
140+ < h3 > Step 5: Transform the Event Data</ h3 >
141141
142142Port expects a simplified payload. Use Input Transformer to map the raw AWS event:
143143
144144** Input Path (mapping):**
145- ``` json
145+ ``` json showLineNumbers
146146{
147147 "accountId" : " $.account" ,
148148 "awsRegion" : " $.region" ,
@@ -152,7 +152,7 @@ Port expects a simplified payload. Use Input Transformer to map the raw AWS even
152152```
153153
154154** Template (output):**
155- ``` json
155+ ``` json showLineNumbers
156156{
157157 "resource_type" : " AWS::SSM::Parameter" ,
158158 "accountId" : " <accountId>" ,
@@ -169,25 +169,25 @@ Replace `"AWS::SSM::Parameter"` with the appropriate AWS resource type:
169169- CloudFormation Stacks: ` "AWS::CloudFormation::Stack" `
170170:::
171171
172- ### Step 6: Review & Create
172+ < h3 > Step 6: Review & Create</ h3 >
173173
1741741 . Click ** Next** → ** Next** → ** Create rule**
1751752 . AWS will now forward matching events to Port automatically
176176
177177</TabItem >
178178</Tabs >
179179
180- ## Testing Your Setup
180+ ## Testing your setup
181181
182- ### Verify Existing Rules
182+ ### Verify existing rules
183183
184184If you have other live event rules (e.g., S3 Bucket sync), verify they're working:
185185
1861861 . Go to ** EventBridge** → ** Rules**
1871872 . Check that your rules are ** Enabled**
1881883 . Look for any recent invocations in the ** Metrics** tab
189189
190- ### Test Live Events
190+ ### Test live events
191191
1921921 . ** Trigger a test event** :
193193 - Modify/create a resource (e.g., create an SSM Parameter)
@@ -198,7 +198,7 @@ If you have other live event rules (e.g., S3 Bucket sync), verify they're workin
198198 - Check your software catalog for real-time updates
199199 - Look for the resource changes in Port's interface
200200
201- ### Example Test for SSM Parameters
201+ ### Example test for SSM parameters
202202
2032031 . Go to ** Systems Manager** → ** Parameter Store**
2042042 . Create a new parameter:
@@ -209,7 +209,7 @@ If you have other live event rules (e.g., S3 Bucket sync), verify they're workin
209209
210210## Troubleshooting
211211
212- ### Common Issues
212+ ### Common issues
213213
214214** Events not appearing in Port:**
215215- Verify the EventBridge rule is enabled
0 commit comments