diff --git a/Home.md b/Home.md index 93a012c..6db6d71 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,39 @@ -# Deploy the Project on CamelX Platform +# AWS SQS FIFO Sink -Deploy on CamelX Platform in three steps +Send message to an AWS SQS FIFO Queue. -## 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 SQS | +| 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 | +|------|------|----------|---------|-------------| +| `queueNameOrArn` | string | ✓ | | The SQS Queue name or ARN | +| `accessKey` | string | | | The access key obtained from AWS. | +| `secretKey` | string | | | The secret key obtained from AWS. | +| `region` | string | ✓ | | The AWS region to access. | +| `contentBasedDeduplication` | boolean | | `false` | Use content-based deduplication (should be enabled in the SQS FIFO queue first) | +| `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 | +| `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 -Enable **"Expose"** +## Dependencies -Choose an **API Gateway** (Internal, Public, etc.) +- `camel:aws2-sqs` +- `camel:core` +- `camel:kamelet`