AWS S3 Streaming upload Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Upload data to AWS S3 in streaming upload mode.

Access Key/Secret Key are the basic method for authenticating to the AWS S3 Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'.

When using a default Credentials Provider the S3 client will load the credentials through this provider and won’t use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet.

Configuration Options

The following table summarizes the configuration options available for the aws-s3-streaming-upload-sink Kamelet:

Property Name Description Type Default Example

Property	Name	Description	Type	Default
bucketNameOrArn	Bucket Name	Required The S3 Bucket name or Amazon Resource Name (ARN)..	string
keyName	Key Name	Required Setting the key name for an element in the bucket through endpoint parameter. In Streaming Upload, with the default configuration, this will be the base for the progressive creation of files.	string
region	AWS Region	Required The AWS region to access. Enum values: * ap-south-1 * eu-south-1 * us-gov-east-1 * me-central-1 * ca-central-1 * eu-central-1 * us-iso-west-1 * us-west-1 * us-west-2 * af-south-1 * eu-north-1 * eu-west-3 * eu-west-2 * eu-west-1 * ap-northeast-3 * ap-northeast-2 * ap-northeast-1 * me-south-1 * sa-east-1 * ap-east-1 * cn-north-1 * us-gov-west-1 * ap-southeast-1 * ap-southeast-2 * us-iso-east-1 * ap-southeast-3 * us-east-1 * us-east-2 * cn-northwest-1 * us-isob-east-1 * aws-global * aws-cn-global * aws-us-gov-global * aws-iso-global * aws-iso-b-global	string
accessKey	Access Key	The access key obtained from AWS.	string
autoCreateBucket	Autocreate Bucket	Setting the autocreation of the S3 bucket bucketName.	boolean	false
batchMessageNumber	Batch Message Number	The number of messages composing a batch in streaming upload mode.	integer	10
batchSize	Batch Size	The batch size (in bytes) in streaming upload mode.	integer	1000000
forcePathStyle	Force Path Style	Forces path style when accessing AWS S3 buckets.	boolean	false
namingStrategy	Naming Strategy	The naming strategy to use in streaming upload mode. There are 2 enums and the value can be one of progressive, random.	string	progressive
overrideEndpoint	Endpoint Overwrite	Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option.	boolean	false
profileCredentialsName	Profile Credentials Name	If using a profile credentials provider this parameter will set the profile name.	string
restartingPolicy	Restarting Policy	The restarting policy to use in streaming upload mode. There are 2 enums and the value can be one of override, lastPart.	string	lastPart
secretKey	Secret Key	The secret key obtained from AWS.	string
sessionToken	Session Token	Amazon AWS Session Token used when the user needs to assume a IAM role.	string
streamingUploadTimeout	Streaming Upload Timeout	While streaming upload mode is true, this option set the timeout to complete upload.	integer
uriEndpointOverride	Overwrite Endpoint URI	The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option.	string
useDefaultCredentialsProvider	Default Credentials Provider	Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.	boolean	false
useProfileCredentialsProvider	Profile Credentials Provider	Set whether the S3 client should expect to load credentials through a profile credentials provider.	boolean	false
useSessionCredentials	Session Credentials	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.	boolean	false

bucketNameOrArn

Bucket Name

Required The S3 Bucket name or Amazon Resource Name (ARN)..

string

keyName

Key Name

Required Setting the key name for an element in the bucket through endpoint parameter. In Streaming Upload, with the default configuration, this will be the base for the progressive creation of files.

string

region

AWS Region

Required The AWS region to access.

Enum values:

* ap-south-1 * eu-south-1 * us-gov-east-1 * me-central-1 * ca-central-1 * eu-central-1 * us-iso-west-1 * us-west-1 * us-west-2 * af-south-1 * eu-north-1 * eu-west-3 * eu-west-2 * eu-west-1 * ap-northeast-3 * ap-northeast-2 * ap-northeast-1 * me-south-1 * sa-east-1 * ap-east-1 * cn-north-1 * us-gov-west-1 * ap-southeast-1 * ap-southeast-2 * us-iso-east-1 * ap-southeast-3 * us-east-1 * us-east-2 * cn-northwest-1 * us-isob-east-1 * aws-global * aws-cn-global * aws-us-gov-global * aws-iso-global * aws-iso-b-global

string

accessKey

Access Key

The access key obtained from AWS.

string

autoCreateBucket

Autocreate Bucket

Setting the autocreation of the S3 bucket bucketName.

boolean

false

batchMessageNumber

Batch Message Number

The number of messages composing a batch in streaming upload mode.

integer

batchSize

Batch Size

The batch size (in bytes) in streaming upload mode.

integer

1000000

forcePathStyle

Force Path Style

Forces path style when accessing AWS S3 buckets.

boolean

false

namingStrategy

Naming Strategy

The naming strategy to use in streaming upload mode. There are 2 enums and the value can be one of progressive, random.

string

progressive

overrideEndpoint

Endpoint Overwrite

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

boolean

false

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter will set the profile name.

string

restartingPolicy

Restarting Policy

The restarting policy to use in streaming upload mode. There are 2 enums and the value can be one of override, lastPart.

string

lastPart

secretKey

Secret Key

The secret key obtained from AWS.

string

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string

streamingUploadTimeout

Streaming Upload Timeout

While streaming upload mode is true, this option set the timeout to complete upload.

integer

uriEndpointOverride

Overwrite Endpoint URI

The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

string

useDefaultCredentialsProvider

Default Credentials Provider

Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the S3 client should expect to load credentials through a profile credentials provider.

boolean

false

useSessionCredentials

Session Credentials

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.

boolean

false

Dependencies

At runtime, the aws-s3-streaming-upload-sink Kamelet relies upon the presence of the following dependencies:

camel:aws2-s3
camel:kamelet

Camel JBang usage

Prerequisites

You’ve installed JBang.
You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:aws-s3-streaming-upload-sink"

You can now run it directly through the following command

camel run route.yaml

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml