From 72eb9d17f21beaef69fd50bf5bb28e2ad4a4a0ca Mon Sep 17 00:00:00 2001 From: gitea_admin Date: Wed, 11 Mar 2026 14:34:31 +0000 Subject: [PATCH] Update wiki Home page for aws-kinesis-source --- Home.md | 46 ++++++++++++++++++++++++++++++++-------------- 1 file changed, 32 insertions(+), 14 deletions(-) diff --git a/Home.md b/Home.md index 93a012c..1efc739 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,39 @@ -# Deploy the Project on CamelX Platform +# AWS Kinesis Source -Deploy on CamelX Platform in three steps +Receive data from AWS Kinesis. -## 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 Kinesis | +| 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 | +|------|------|----------|---------|-------------| +| `stream` | string | ✓ | | The Kinesis stream that you want to access. The Kinesis stream that you specify must already exist. | +| `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 Kinesis 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 Kinesis client should expect to load credentials through a profile credentials provider. | +| `useSessionCredentials` | boolean | | `false` | Set whether the Kinesis 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 Kinesis. | +| `profileCredentialsName` | string | | | If using a profile credentials provider this parameter will set 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. | +| `delay` | integer | | `500` | The number of milliseconds before the next poll of the selected stream. | +| `asyncClient` | boolean | | `false` | If we want to a KinesisAsyncClient instance set it to true. | +| `useKclConsumers` | boolean | | `false` | If we want to a KCL Consumer set it to true | +| `kclDisableCloudwatchMetricsExport` | boolean | | `false` | Define if we want to use a KCL Consumer and disable the CloudWatch Metrics Export | -## Step 3: Expose -Enable **"Expose"** +## Dependencies -Choose an **API Gateway** (Internal, Public, etc.) +- `camel:aws2-kinesis` +- `camel:kamelet` +- `camel:core`