AWS S3 Sink
Provided by: "Apache Software Foundation"
Support Level for this Kamelet is: "Stable"
Upload data to an Amazon S3 Bucket.
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.
If you use the default credentials provider, the S3 client loads the credentials through this provider and doesn’t use the basic authentication method.
In the header, you can optionally set the file
/ ce-partition
property to specify the name of the file to upload.
If you do not set the property in the header, the Kamelet uses the exchange ID for the file name.
Configuration Options
The following table summarizes the configuration options available for the aws-s3-sink
Kamelet:
Property | Name | Description | Type | Default | Example |
---|---|---|---|---|---|
Bucket Name | Required The S3 Bucket name or Amazon Resource Name (ARN). | string | |||
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 | |||
Access Key | The access key obtained from AWS. | string | |||
Autocreate Bucket | Specifies to automatically create the S3 bucket. | boolean | false | ||
Force Path Style | Forces path style when accessing AWS S3 buckets. | boolean | false | ||
Key Name | The key name for saving an element in the bucket. | string | |||
Endpoint Overwrite | Select this option to override the endpoint URI. To use this option, you must also provide a URI for the | boolean | false | ||
Secret Key | The secret key obtained from AWS. | string | |||
Overwrite Endpoint URI | The overriding endpoint URI. To use this option, you must also select the | string | |||
Default Credentials Provider | 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). | boolean | false |
Dependencies
At runtime, the aws-s3-sink
Kamelet relies upon the presence of the following dependencies:
-
camel:core
-
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-sink"
You can now run it directly through the following command
camel run route.yaml