Amazon S3 Connector Skip to main content
Developer Portal
Mendix

Amazon S3 Connector

Allows you to export data from your Mendix application to Dremio.


Documentation

Description

This is a small S3 Connector designed to allow you to connect to data found in a S3 bucket. Currently this connector only uses the GetObject, PutObject, and ListBucket actions in S3, so the module isn’t able to use all of the functionality found in the S3 API.

Typical Usage Scenario

If you have a web application that Dremio needs to access you should use the Amazon S3 Connector. Use this if there are other Amazon services that need access to Amazon S3. It's much easier for Amazon services to connect to S3 than it is for them to connect to an outside source, like Box.

How to Use

The module includes a handful of Java actions that are exposed as microflow actions. They are named according to the action that they execute. Here is a quick explanation of what the current actions do:

  • Get Object - Here you pass in the key of the object in S3, and this will return an S3File object with the file contents.
  • Get Object Content - This does the same thing as Get Object, other than it returns a string with the file content instead of an S3File object. This is useful when all you need is the content of a text file, and you don’t want Mendix to store the file.
  • Put Object - With this action, you pass in an S3File object with the file you wish to upload, and the object key that it will be identified by in S3. It will then upload that file to S3, and identify it by that object key.
  • List Bucket – This will return a ListBucketResult object that holds some metadata about the bucket, and then a list of ObjectInfo objects that have info on the objects in the bucket.

Future Development

If this module gets used, the functionality of this module may need to be extended. This was created for a special use case in one of our applications, so usage will be low. Any feature requests should be put as feature requests/issues on the Github repository.

Dependencies

There are no dependencies at the moment.

Installation

  1. Download the module here. It will save as AmazonS3Connector.mpk
    1. Note: If you are using Mendix Studio Pro 8.8.* or 8.9.* downloading private app store modules/widgets was turned off due to security concerns. All the BYU Private App Store content can still be downloaded from the Company Content page in the Mendix App Store and then imported into those versions of Studio Pro. Upgrading to a newer version of Mendix Studio Pro fixes the problem.
  2. After the download finishes, import Amazon S3 Connector into your project.
    1. Right click on your Project Explorer
    2. Select Import Module Package
    3. Select the module you just downloaded and click Open

Slack

For additional help, refer to the appropriate slack channels in their respective workspaces:

  1. BYU-OIT workspace
    1. #api-management
    2. #mendix
  2. BYU-Web workspace
    1. #mendix-user-group