camel.apache.org/aws-s3-source
1
0
Fork 0
generated from camel.apache.org/kamelet
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update wiki Home page for aws-s3-source

gitea_admin 2026-03-11 14:34:37 +00:00
parent 9fac4ddbb7
commit 40d9eacea8
1 changed files with 45 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
Home.md

@ -1,21 +1,52 @@
# Deploy the Project on CamelX Platform
# AWS S3 Source
Deploy on CamelX Platform in three steps
Receive data from an Amazon S3 Bucket.
## Step 1: Create a release
From the project space, click on **"Create a release"**
The basic authentication method for the S3 service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider.
The new version is automatically available in the list
If you use the default credentials provider, the S3 client loads the credentials through this provider and doesn't use the basic authentication method.
## Step 2: Deploy
Click on **"Deploy"**
Two headers will be duplicated with different names for clarity at sink level, CamelAwsS3Key will be duplicated into aws.s3.key and CamelAwsS3BucketName will be duplicated in aws.s3.bucket.name
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
## Metadata
## Step 3: Expose
Enable **"Expose"**
| Property | Value |
|----------|-------|
| Type | source |
| Group | AWS S3 |
| Namespace | AWS |
| Support Level | Stable |
| Provider | Apache Software Foundation |
Choose an **API Gateway** (Internal, Public, etc.)
## Properties
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `bucketNameOrArn` | string | ✓ | | The S3 Bucket name or Amazon Resource Name (ARN). |
| `deleteAfterRead` | boolean | | `true` | Specifies to delete objects after consuming them. |
| `moveAfterRead` | boolean | | `false` | Move objects from S3 bucket to a different bucket after they have been retrieved. |
| `destinationBucket` | string | | | Define the destination bucket where an object must be moved when moveAfterRead is set to true. |
| `destinationBucketPrefix` | string | | | Define the destination bucket prefix to use when an object must be moved, and moveAfterRead is set to true. |
| `destinationBucketSuffix` | string | | | Define the destination bucket suffix to use when an object must be moved, and moveAfterRead is set to true. |
| `accessKey` | string | | | The access key obtained from AWS. |
| `secretKey` | string | | | The secret key obtained from AWS. |
| `region` | string | ✓ | | The AWS region to access. |
| `autoCreateBucket` | boolean | | `false` | Specifies to automatically create the S3 bucket. |
| `prefix` | string | | | The AWS S3 bucket prefix to consider while searching. |
| `ignoreBody` | boolean | | `false` | If true, the S3 Object body is ignored. Setting this to true overrides any behavior defined by the `includeBody` option. If false, the S3 object is put in the body. |
| `useDefaultCredentialsProvider` | boolean | | `false` | If true, the S3 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 S3 client should expect to load credentials through a profile credentials provider. |
| `useSessionCredentials` | boolean | | `false` | Set whether the S3 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 S3. |
| `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. |
| `forcePathStyle` | boolean | | `false` | Forces path style when accessing AWS S3 buckets. |
| `delay` | integer | | `500` | The number of milliseconds before the next poll of the selected bucket. |
| `maxMessagesPerPoll` | integer | | `10` | Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited. |
## Dependencies
- `camel:core`
- `camel:aws2-s3`
- `camel:kamelet`