Account storage

Choose whether Umnai or your organisation provides the storage used for platform-created resources.

View as Markdown

Each Umnai account has an account storage bucket. The platform uses this bucket for resources it creates and manages, including datasources, datasets, cache entries, models, data, and metadata.

Account storage is configured when Umnai creates your account during onboarding. It can be either:

  • Provisioned storage, where Umnai provisions and manages the bucket; or
  • Provided storage, where your organisation supplies and manages an Amazon S3 bucket.

Account storage and source-data storage have different roles.

Source-data storage contains files you upload and normally uses read-only access through a storage connector. Account storage contains resources created by the platform and requires read, write, and delete access.

Understand the two storage roles

StoragePurposeAccess required
Source-data storageContains CSV or Parquet files that you want to ingest.Read-only access through a storage connector.
Account storageContains platform-created datasources, datasets, models, cache entries, data, and metadata.Read, write, and delete access. It can be provisioned by Umnai or provided by your organisation.

You need a source-data location when ingesting your own data, regardless of which account storage option you select.

If you select provided account storage, the source-data and account-storage roles can use the same S3 bucket. However, a dedicated account storage bucket is strongly recommended. It isolates platform-created resources and their broader permissions from your source files, and avoids conflicts with paths or naming conventions created by the platform.

Choose an account storage option

Provisioned storage

With PROVISIONED storage, Umnai creates and manages the account storage bucket on your behalf.

Choose this option when your organisation does not need to own or manage the bucket used for platform-created resources.

To request provisioned storage:

  1. Contact Umnai support.
  2. Ask for the account to use PROVISIONED storage.
  3. Wait for confirmation that the account is ready.

You do not need to create or configure the account storage bucket. You may still need to connect a source-data location before running ingestion.

Provided storage

With PROVIDED storage, your organisation creates and manages the account storage bucket.

Choose this option when your organisation needs platform-created resources to remain in an S3 bucket that it owns.

Before Umnai can create the account, you must:

  1. create the S3 bucket;
  2. grant the Umnai platform access to it; and
  3. provide the bucket details to Umnai support.

Prepare a provided account storage bucket

Bucket requirements

The bucket must:

  • be created in the AWS Region agreed with Umnai during onboarding;
  • have a globally unique name;
  • be accessible to the Umnai platform AWS account; and
  • allow the platform to read, create, update, and delete account resources.

AWS S3 bucket names must be globally unique. If your preferred name is unavailable, choose another name that identifies your organisation and the bucket’s purpose.

Create the bucket

If you are creating a dedicated account storage bucket, use the AWS Console:

  1. Open Amazon S3.
  2. Ensure that the selected AWS Region matches the region agreed with Umnai during onboarding.
  3. Create a general-purpose bucket.
  4. Enter a globally unique bucket name.
  5. Complete the bucket creation process using the security settings required by your organisation.

Save the bucket name. You will provide it to Umnai support.

Grant platform access

Open the bucket’s Permissions tab and edit its bucket policy.

  1. Obtain the Umnai platform AWS account ID for your environment from Umnai support.

  2. Replace <ACCOUNT-ID> with the account ID provided to you and <YOUR-BUCKET-NAME> with the name of your account storage bucket:

    {
    "Version": "2012-10-17",
    "Statement": [
    {
    "Sid": "AllowAccountStorageObjectControl",
    "Effect": "Allow",
    "Principal": {
    "AWS": "arn:aws:iam::<ACCOUNT-ID>:root"
    },
    "Action": [
    "s3:GetObject",
    "s3:PutObject",
    "s3:DeleteObject"
    ],
    "Resource": "arn:aws:s3:::<YOUR-BUCKET-NAME>/*"
    },
    {
    "Sid": "AllowAccountStorageBucketAccess",
    "Effect": "Allow",
    "Principal": {
    "AWS": "arn:aws:iam::<ACCOUNT-ID>:root"
    },
    "Action": [
    "s3:ListBucket",
    "s3:GetBucketLocation"
    ],
    "Resource": "arn:aws:s3:::<YOUR-BUCKET-NAME>"
    }
    ]
    }
  3. Select Save changes. You should see confirmation that the bucket policy was updated.

This policy grants the platform read, write, and delete access to objects throughout the bucket.

If you reuse a source-data bucket for provided account storage, those broader permissions also apply to the source objects in that bucket. A dedicated account storage bucket is strongly recommended. Confirm the bucket layout and policy with Umnai support before reusing a bucket.

Request account creation

After the bucket and policy are ready, contact Umnai support and provide:

  • the requested account name;
  • PROVIDED as the storage option;
  • the S3 bucket name;
  • the agreed AWS Region; and
  • the environment in which the account will run.

Umnai support will configure the account to use the provided bucket and confirm when the account is ready.

Verify the account configuration

After receiving access to the account, retrieve it through the Accounts API.

The response includes its storage configuration:

{
"storage_configuration": {
"storage_configuration_type": "PROVIDED",
"bucket_name": "your-account-storage-bucket"
}
}

Confirm that:

  • storage_configuration_type is PROVIDED; and
  • bucket_name matches the bucket supplied during onboarding.

For provisioned storage, storage_configuration_type is PROVISIONED, and bucket_name identifies the bucket managed by Umnai.

Next steps

After the account is ready:

  1. create or obtain account API credentials;
  2. prepare the source data you want to ingest;
  3. configure access to the source-data location; and
  4. create a storage connector for that source-data location.

Continue to Account credentials or Source storage.