Skip to main content

Amazon S3

This guide contains the required information to set up S3 Sink in Vanus Connect.

Introduction

Amazon S3 (Simple Storage Service) is a highly scalable and durable object storage service provided by Amazon Web Services (AWS). It is designed to store and retrieve any amount of data from anywhere on the internet, making it ideal for a wide range of use cases such as backup and restore, disaster recovery, data archiving, content delivery, and big data analytics.

With Amazon S3 Sink in Vanus Connect, you can easily forward data or events to your S3 bucket automatically. The S3 Sink connector lets you save the events you need to any bucket of your choosing.

Prerequisites

Before forwarding events to an S3 bucket, you must have:

Getting Started

Step 1: Create an AWS User

  1. Log in to the AWS Management Console using your root account credentials.

  2. Navigate to the IAM service by searching for IAM① and clicking the IAM② service.

aws-s3-sink-1

  1. Click on the Users tab③ in the left navigation menu, and then click the Create user④ button.

aws-s3-sink-2

  1. Write your User name⑤ and click Next⑥.

aws-s3-sink-3

  1. Select Attach policies directly⑦, and click on Create policy⑧.

aws-s3-sink-4

  1. Search for s3⑨ and select s3⑩.

aws-s3-sink-5

  1. Search⑪ and select the required Actions.

aws-s3-sink-6

  • PutObject
  • GetObject
  • GetObjectVersion
  • DeleteObject
  • DeleteObjectVersion

aws-s3-sink-7

  1. Select Any⑬ and click Next⑭ to proceed to the next page.

aws-s3-sink-8

  1. Specify a Policy name⑮.

aws-s3-sink-9

  1. Click Create policy⑯.

aws-s3-sink-10

  1. Return to your previous TAB.

  2. Refresh⑰ the policy list, search⑱ for your custom policy, select your created policy⑲, and click Next⑳.

aws-s3-sink-11

  1. Review and click Create user㉑.

aws-s3-sink-12


Step 2: Get your Access key and Secret access key

  1. Now click on the User① you just created.

aws-s3-sink-13

  1. Under Security credentials②, scroll down the page to Access Keys, and Click Create access key③.

aws-s3-sink-14

  1. Select Command line interface (CLI)④, tick the confirmation box⑤ and click Next⑥.

aws-s3-sink-15

  1. Click Create access key⑦.

aws-s3-sink-16

  1. Download your Access key and Secret access key by clicking the Download .csv file⑧ button, and then click Done⑨.

aws-s3-sink-17


Step 3: Amazon S3 Connection Settings

To set up S3 Sink in Vanus Connect:

  1. Enter your Access Key① and Secret access Key② in Vanus Connect from the previous steps.

aws-s3-sink-18

  1. Now let's go back to Amazon Web Services under the Amazon S3 service.

  2. At this point, you can either create a new bucket or select an existing bucket.

  3. Create a new bucket by clicking the Create bucket③ button.

aws-s3-sink-19

  1. Specify a Bucket name④ and select your desired AWS Region⑤.

aws-s3-sink-20

  1. Click on Create bucket⑥ to finish creating your bucket.

aws-s3-sink-21

  1. After selecting or creating a bucket, remember to take note of your bucket name⑦ and the AWS Region⑧.

aws-s3-sink-22

  1. In Vanus Connect, choose your Region⑨ and enter your Bucket⑩ name, select the upload interval time⑪ (HOURLY or DAILY).

aws-s3-sink-23


Step 4: Personalize Event Structure

note

This is a general instruction on how to personalize your event structure. You can structure your events to suit your specific requirements and create connections for different scenarios.

  1. Click on Display sample events① for reference and click on Add More② to add events.

aws-s3-sink-24

  1. Input key③ and search for the corresponding value④ for the event you want.

aws-s3-sink-25

  1. You can fill in as many key-value pairs⑤ as you wish to receive.

aws-s3-sink-26

  1. Click Submit⑥ to finish the configuration process.

aws-s3-sink-27


Required Data Format

The event data must be in JSON format with the following way:

{
"data": {
"myData": "simulation event data"
}
}