Update wiki Home page for aws-sqs-batch-sink

gitea_admin 2026-03-11 14:34:43 +00:00
parent 92e6479b70
commit 6e7091a09c

45
Home.md

@ -1,21 +1,38 @@
# Deploy the Project on CamelX Platform # AWS SQS Batch Sink
Deploy on CamelX Platform in three steps Send Batch message to an AWS SQS Queue.
## Step 1: Create a release ## Metadata
From the project space, click on **"Create a release"**
The new version is automatically available in the list | Property | Value |
|----------|-------|
| Type | sink |
| Group | AWS SQS |
| Namespace | AWS |
| Support Level | Stable |
| Provider | Apache Software Foundation |
## Step 2: Deploy ## Properties
Click on **"Deploy"**
- **Version:** Select the desired release | Name | Type | Required | Default | Description |
- **Environment:** Choose `Development`, `Staging`, or `Production` |------|------|----------|---------|-------------|
- **Configuration:** Select the configuration source | `queueNameOrArn` | string | ✓ | | The SQS Queue name or ARN |
- **Resources:** Set CPU and Memory | `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. |
| `batchSeparator` | string | ✓ | | The batch separator string |
| `amazonAWSHost` | string | | `amazonaws.com` | The hostname of the Amazon AWS cloud. |
| `protocol` | string | | `https` | The underlying protocol used to communicate with SQS |
| `useDefaultCredentialsProvider` | boolean | | `false` | Set whether the SQS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. |
| `useProfileCredentialsProvider` | boolean | | `false` | Set whether the SQS client should expect to load credentials through a profile credentials provider. |
| `useSessionCredentials` | boolean | | `false` | Set whether the SQS 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 SQS. |
| `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. |
## Step 3: Expose ## Dependencies
Enable **"Expose"**
Choose an **API Gateway** (Internal, Public, etc.) - `camel:aws2-sqs`
- `camel:kamelet`