diff --git a/Home.md b/Home.md index 93a012c..4e68942 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,42 @@ -# Deploy the Project on CamelX Platform +# AWS S3 Streaming upload Sink -Deploy on CamelX Platform in three steps +Upload data to AWS S3 in streaming upload mode. -## 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 S3 | +| 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 | +|------|------|----------|---------|-------------| +| `bucketNameOrArn` | string | ✓ | | The S3 Bucket name or Amazon Resource Name (ARN). | +| `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` | Setting the autocreation of the S3 bucket bucketName. | +| `restartingPolicy` | string | | `lastPart` | The restarting policy to use in streaming upload mode. There are 2 enums and the value can be one of `override`, `lastPart`. | +| `batchMessageNumber` | integer | | `10` | The number of messages composing a batch in streaming upload mode. | +| `batchSize` | integer | | `1000000` | The batch size (in bytes) in streaming upload mode. | +| `streamingUploadTimeout` | integer | | | While streaming upload mode is true, this option set the timeout to complete upload. | +| `namingStrategy` | string | | `progressive` | The naming strategy to use in streaming upload mode. There are 2 enums and the value can be one of progressive, random. | +| `keyName` | string | ✓ | | Setting the key name for an element in the bucket through endpoint parameter. In Streaming Upload, with the default configuration, this is the base for the progressive creation of files. | +| `useDefaultCredentialsProvider` | boolean | | `false` | Set whether the S3 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 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. | -## Step 3: Expose -Enable **"Expose"** +## Dependencies -Choose an **API Gateway** (Internal, Public, etc.) +- `camel:aws2-s3` +- `camel:kamelet`