Welcome to Zuora Product Documentation

Explore our rich library of product information

Create an external AWS S3 connection

Create an external S3 connection when you want to use your own AWS S3 bucket.

Creating an external S3 connection involves a four-step wizard: Connection Type, S3 Bucket, IAM Role, and Validate.
  1. Navigate to Mediation > Meters.
  2. Click the Manage Connections button at the top of the page.
    The Manage Connections window is displayed and lists all existing connections with the connection details.
  3. Click Create New to create a new connection.
  4. From the list of connection types, select AWS S3.
  5. Under Choose AWS S3 Type, select Bring your own S3 bucket and click Continue.
  6. On the S3 Bucket step, provide the bucket configuration:
    1. Connection Name (required) – unique name for the S3 connection.
    2. AWS Account ID (required) – must contain exactly 12 numeric digits.
    3. Bucket Name (required).
    4. Region (required) – select from the drop-down list.
    5. Base Path (optional) – must not start with / and must not contain ..
    6. Click Create & Continue to go to the IAM Role step.
  7. On the IAM Role step, the window displays instructions and IAM details that you use to configure the role in AWS. You must:
    1. Follow the instructions and complete the steps in your AWS environment.
      The window also diaplays:
      • IAM Role Name (system-generated, do not modify) – the role name that Zuora expects for this connection.

      • Trust Policy – a JSON policy document to use as the role's trust relationship in AWS.

    2. After completing the steps in your AWS environment, select the checkbox confirming that you have completed the instructions.
    3. Click Continue to go to the Validate step.
  8. On the Validate step, click Validate.

    Zuora attempts to access the S3 bucket using the configured IAM role.

    If validation succeeds, a Validation Successful message is displayed, stating that all checks have passed and the S3 bucket is properly configured and ready to activate. The Activate Connection button becomes available.

    If validation fails, a Validation Failed message indicates that Zuora was unable to access the S3 bucket with the provided IAM role and instructs you to review the configuration. The Activate Connection button remains disabled and a Revalidate button is available so that you can fix the configuration and run validation again.

  9. After validation succeeds, click Activate Connection.

The connection status changes from Draft to Active and the S3 connection appears as active in the Connections list.