S3SrcConn

class

class S3SrcConn(
    bucket: S3BucketSpec,
    region: AwsRegionSpec,
    credentials: CredentialsSpec,
    base_path: CloudRelativePathSpec = '/',
    conn_cfg: CfgSpec | None = None,
)

Bases: Conn

Categories: source

S3 connection used by S3Src.

Registered on a collection; the runtime resolves it and hands it to the plugin at run time. Each field accepts a plain string or a Secret.

Parameters

parameter

bucketS3BucketSpec (str | Secret)

A valid S3 bucket name.

parameter

regionAwsRegionSpec (str | Secret)

A valid AWS region, e.g. us-east-1.

parameter

credentialsCredentialsSpec (AwsAccessSecretKey)

AWS AwsAccessSecretKey credentials.

parameter

base_pathCloudRelativePathSpec (str | Secret)

Object-key prefix from the bucket root; starts with /, has no trailing / and no empty segments (//) (the leading / is trimmed when forming the key). Defaults to /.

parameter

conn_cfgCfgSpec | None (dict | None)

Optional connector-config dict (see CfgSpec).