Skip to main content

Setup Guide

This guide walks you through creating an AWS IAM user and obtaining the access credentials required to use the AWS S3 connector.

Prerequisites​

  • An active AWS account. If you do not have one, sign up here.

Step 1: Sign in to the AWS Management Console​

  1. Go to console.aws.amazon.com and sign in.
  2. In the top navigation bar, select the AWS Region where you want to create your S3 buckets (for example, us-east-1).

Step 2: Create an IAM user​

  1. Open the IAM console at console.aws.amazon.com/iam/.
  2. In the left navigation pane, select Users, then select Create user.
  3. Enter a User name (for example, ballerina-s3-connector) and select Next.
  4. Under Set permissions, select Attach policies directly.
  5. Search for and select the AmazonS3FullAccess managed policy (or a custom policy with the minimum S3 permissions your integration requires).
  6. Select Next, review the details, and select Create user.
tip

For production use, follow the principle of least privilege — create a custom IAM policy that grants only the specific S3 actions and resources your integration needs.

Step 3: Generate access keys​

  1. In the IAM console, select the user you just created.
  2. Go to the Security credentials tab.
  3. Under Access keys, select Create access key.
  4. Select the Application running outside AWS use case, then select Next.
  5. Optionally add a description tag, then select Create access key.
  6. Copy the Access key ID and Secret access key — these are your accessKeyId and secretAccessKey.
warning

The secret access key is shown only once. Store both keys securely and do not commit them to source control. Use Ballerina's configurable feature and a Config.toml file to supply them at runtime.

Step 4: Note your AWS region​

Identify the AWS Region for your S3 operations (for example, us-east-1, eu-west-1, ap-southeast-1). This value is passed as the region configuration parameter when initializing the connector.

note

If you do not specify a region, the connector defaults to US East (N. Virginia) (us-east-1).

What's next​