Skip to Content

Storage file

An external storage connection. Its credentials are entered in the UI, or read from an environment secret group when `credentials:` is set.

Schema definition: StorageFile.

Example

A minimal storages/<name>.yaml:

storages/archive.yaml
# yaml-language-server: $schema=https://a-line.cloud/schemas/iac/v1.json
version: 1
endpoint: https://s3.example.net
region: eu-central-1
bucket: archive

Fields

bucket

Type: string, optional.

The provider's bucket.

credentials

Type: StorageCredentialsSpec, optional.

Where the access key pair lives: keys of a secret group of the project's environment (project links only). Set, the console cannot edit the credentials; absent, they are entered in the UI.

delete

Type: boolean, optional.

Tombstone: delete the connection (held until confirmed).

endpoint

Type: string, optional.

The S3 endpoint URL.

force_path_style

Type: boolean, optional.

Path-style addressing.

name

Type: string, optional.

Optional: defaults to the file name, and must match it when set.

path_prefix

Type: string, optional.

Key prefix inside the bucket.

provider_hint

Type: string, optional.

The provider, for the console: one of aws, r2, wasabi, minio, backblaze, hetzner or other.

region

Type: string, optional.

The region.

version

Type: SchemaVersion, required.

The IaC schema version this file is written for.

On this page