Update wiki Home page for aws-s3-source

Home.md

@@ -1,21 +1,46 @@
-# 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
+## Metadata
-From the project space, click on **"Create a release"**
 
-The new version is automatically available in the list
+| Property | Value |
+|----------|-------|
+| Type | source |
+| Group | AWS S3 |
+| 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
+| `bucketNameOrArn` | string | ✓ |  | The S3 Bucket name or Amazon Resource Name (ARN). |
-- **Resources:** Set CPU and Memory
+| `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 sets 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. |
 
-## Step 3: Expose
+## Dependencies
-Enable **"Expose"**
 
-Choose an **API Gateway** (Internal, Public, etc.)
+- `camel:core`
+- `camel:aws2-s3`
+- `camel:kamelet`