S3 File Store | beVault

Description	Connection to an Amazon/Minio S3 Bucket
Type	s3
Category	File

Configuration in States

The S3 File Store can be configured directly in the States interface via the Data Stores module. The following configuration mode is available:

Parameters

Name	Description	Mandatory	Default	Comment
Service URL	The URL to the S3-compatible service (e.g. a MinIO server)	Yes, if no Region Endpoint	—	If specified, Region Endpoint is ignored
Region Endpoint	The Amazon S3 region endpoint (e.g. `us-east-1`)	Yes, if no Service URL	—	Used to generate the Service URL when connecting to Amazon S3. Ignored if Service URL is specified
Access Key	The user access key	Yes	—
Secret Key	The user secret key	Yes	—	Value is hidden
Bucket Name	The name of the S3 bucket to access	Yes	—

ℹ️ Note: Either Service URL or Region Endpoint must be provided, but not both. Use Service URL for MinIO or S3-compatible services; use Region Endpoint for native Amazon S3 buckets.

Local Configuration

The local configuration is defined in a JSON file (stores.json) deployed directly on the Workers' server. A locally configured store takes priority over a store with the same name configured in the States interface.

Name	Description	Type	Mandatory	Comment
ServiceUrl	URL to the required service	string	True , one of them	The URL to the MinIO server. If this option is specified, "RegionEndPoint" is ignored.
RegionEndPoint	Name of the region endpoint	string	True , one of them	The Amazon database region endpoint. Something like "us-east-1". When using an amazon S3 bucket, this option is used to generate the “ServiceUrl”option. This option is ignored if ServiceUrl is specified.
AccessKey	User access key	string	True
SecretKey	User secret	string	True
BucketName	The name of the bucket to be accessed	string	True

JSON

{
    {
        "Name": "minio-test",
        "Type": "s3",
        "Config": {
          "ServiceUrl": "http://localhost:9000",
          "AccessKey": "test",
          "SecretKey": "testtest",
          "BucketName": "test"
        }
    },
    {
        "Name": "amazon-test",
        "Type": "s3",
        "Config": {
          "RegionEndPoint": "us-east-1",
          "AccessKey": "AKIAIOSFODNN7EXAMPLE",
          "SecretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
          "BucketName": "bucket-of-shrimp-the-fruit-of-the-sea"
        }
    }
}