Update wiki Home page for aws-eventbridge-sink

gitea_admin 2026-10-12 05:29:21 +00:00
parent 35d2990091
commit 726ab5758e

50
Home.md

@ -1,21 +1,43 @@
# Deploy the Project on CamelX Platform
# AWS Eventbridge Sink
Deploy on CamelX Platform in three steps
Send events to an Amazon Eventbridge Eventbus.
In the headers, you can set the `resources-arn` / `ce-resources-arn` property to specify the ARN of resources related to the event.
In the headers, you can set the `detail-type` / `ce-detail-type` property to specify the detail type related to the event.
In the headers, you can set the `event-source` / `ce-event-source` property to specify the event source related to the event.
If you do not set the property in the header, the Kamelet uses the given Kamelet properties as a default.
## 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 | sink |
| Group | AWS Eventbridge |
| Namespace | AWS |
| Support Level | Stable |
| 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 |
|------|------|----------|---------|-------------|
| `eventbusNameOrArn` | string | ✓ | | The Eventbridge Eventbus name or Amazon Resource Name (ARN). |
| `resourcesArn` | string | | | The ARN of resources related to the AWS event (e.g. `arn:aws:s3:eu-east-1:000000000001:test`). |
| `eventSourcePrefix` | string | | `` | The event source prefix set for all events sent to the eventbus. |
| `eventSource` | string | | | The event source related to the AWS event (e.g. `aws.s3`). |
| `detailType` | string | | | The event detail type related to the AWS event. |
| `accessKey` | string | | | The access key obtained from AWS. |
| `secretKey` | string | | | The secret key obtained from AWS. |
| `region` | string | ✓ | | The AWS region to access. |
| `useDefaultCredentialsProvider` | boolean | | `false` | If true, the Eventbridge client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). |
| `useProfileCredentialsProvider` | boolean | | `false` | Set whether the Eventbridge client should expect to load credentials through a profile credentials provider. |
| `useSessionCredentials` | boolean | | `false` | Set whether the Eventbridge client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Eventbridge. |
| `profileCredentialsName` | string | | | If using a profile credentials provider this parameter sets the profile name. |
| `sessionToken` | string | | | Amazon AWS Session Token used when the user needs to assume a IAM role. |
| `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. |
## Step 3: Expose
Enable **"Expose"**
## Dependencies
Choose an **API Gateway** (Internal, Public, etc.)
- `camel:core`
- `camel:aws2-eventbridge`
- `camel:kamelet`