Update wiki Home page for aws-s3-event-based-source

gitea_admin 2026-03-11 14:34:36 +00:00
parent 706c066f64
commit 8d872bbec0

48
Home.md

@ -1,21 +1,41 @@
# Deploy the Project on CamelX Platform
# AWS S3 Event Based Source
Deploy on CamelX Platform in three steps
Receive data from AWS SQS subscribed to Eventbridge Bus reporting events related to an S3 bucket or multiple buckets.
## Step 1: Create a release
From the project space, click on **"Create a release"**
## Metadata
The new version is automatically available in the list
| Property | Value |
|----------|-------|
| Type | source |
| Group | AWS S3 Event-Based |
| Namespace | AWS |
| Support Level | Preview |
| Provider | Apache Software Foundation |
## Step 2: Deploy
Click on **"Deploy"**
## Properties
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `queueNameOrArn` | string | ✓ | | The SQS Queue Name or ARN |
| `deleteAfterRead` | boolean | | `true` | Delete messages after consuming them |
| `accessKey` | string | ✓ | | The access key obtained from AWS. |
| `secretKey` | string | ✓ | | The secret key obtained from AWS. |
| `region` | string | ✓ | | The AWS region to access. |
| `autoCreateQueue` | boolean | | `false` | Setting the autocreation of the SQS queue. |
| `amazonAWSHost` | string | | `amazonaws.com` | The hostname of the Amazon AWS cloud. |
| `protocol` | string | | `https` | The underlying protocol used to communicate with SQS |
| `queueURL` | string | | | The full SQS Queue URL (required if using KEDA) |
| `uriEndpointOverride` | string | | | The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. |
| `overrideEndpoint` | boolean | | `false` | Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. |
| `delay` | integer | | `500` | The number of milliseconds before the next poll of the selected stream |
| `greedy` | boolean | | `false` | If greedy is enabled, then the polling will happen immediately again, if the previous run polled 1 or more messages. |
| `getObject` | boolean | | `false` | If getObject is enabled, then the file created in the bucket will be get and returned as body, if not only the event will returned as body. |
## Step 3: Expose
Enable **"Expose"**
## Dependencies
Choose an **API Gateway** (Internal, Public, etc.)
- `camel:core`
- `camel:aws2-sqs`
- `camel:aws2-s3`
- `camel:jsonpath`
- `camel:kamelet`
- `camel:jackson`