generated from camel.apache.org/kamelet
Update wiki Home page for aws-ddb-streams-source
parent
0b68bd385c
commit
78c19fe6c6
45
Home.md
45
Home.md
@ -1,21 +1,38 @@
|
||||
# Deploy the Project on CamelX Platform
|
||||
# AWS DynamoDB Streams Source
|
||||
|
||||
Deploy on CamelX Platform in three steps
|
||||
Receive events from Amazon DynamoDB Streams.
|
||||
|
||||
## 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 DynamoDB Streams |
|
||||
| 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 |
|
||||
|------|------|----------|---------|-------------|
|
||||
| `table` | string | ✓ | | The name of the DynamoDB table. |
|
||||
| `accessKey` | string | | | The access key obtained from AWS. |
|
||||
| `secretKey` | string | | | The secret key obtained from AWS. |
|
||||
| `region` | string | ✓ | | The AWS region to access. |
|
||||
| `streamIteratorType` | string | | `FROM_LATEST` | Defines where in the DynamoDB stream to start getting records. There are two enums and the value can be one of FROM_LATEST and FROM_START. Note that using FROM_START can cause a significant delay before the stream has caught up to real-time. |
|
||||
| `useDefaultCredentialsProvider` | boolean | | `false` | If true, the DynamoDB 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 DynamoDB client should expect to load credentials through a profile credentials provider. |
|
||||
| `useSessionCredentials` | boolean | | `false` | Set whether the DynamoDB 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 DynamoDB. |
|
||||
| `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 from the database. |
|
||||
|
||||
## Step 3: Expose
|
||||
Enable **"Expose"**
|
||||
## Dependencies
|
||||
|
||||
Choose an **API Gateway** (Internal, Public, etc.)
|
||||
- `null`
|
||||
- `camel:gson`
|
||||
- `camel:aws2-ddb`
|
||||
- `camel:kamelet`
|
||||
|
||||
Loading…
Reference in New Issue
Block a user