S3
Package: flyte.storage
S3 specific configuration.
Authentication resolution used by Flyte + obstore:
-
If explicit static credentials are provided via Flyte S3 inputs/environment (
access_key_id/secret_access_key), those are used. -
If static credentials are not provided, and both
AWS_PROFILEandAWS_CONFIG_FILEare available, Flyte configures a boto3-backed obstore credential provider so profile-based auth can be used. This requires that theboto3library is installed. -
If neither of the above applies, obstore uses the default AWS credential chain (for remote runs this commonly resolves via workload identity / IAM attached to the service account and then IMDS fallbacks where applicable).
class S3(
retries: int,
backoff: datetime.timedelta,
enable_debug: bool,
attach_execution_metadata: bool,
endpoint: typing.Optional[str],
access_key_id: typing.Optional[str],
secret_access_key: typing.Optional[str],
region: typing.Optional[str],
addressing_style: typing.Optional[str],
)| Parameter | Type | Description |
|---|---|---|
retries |
int |
|
backoff |
datetime.timedelta |
|
enable_debug |
bool |
|
attach_execution_metadata |
bool |
|
endpoint |
typing.Optional[str] |
|
access_key_id |
typing.Optional[str] |
|
secret_access_key |
typing.Optional[str] |
|
region |
typing.Optional[str] |
|
addressing_style |
typing.Optional[str] |
Methods
| Method | Description |
|---|---|
auto() |
:return: Config. |
for_sandbox() |
:return:. |
get_fsspec_kwargs() |
Returns the configuration as kwargs for constructing an fsspec filesystem. |
auto()
def auto(
region: str | None,
) -> S3:return: Config
| Parameter | Type | Description |
|---|---|---|
region |
str | None |
for_sandbox()
def for_sandbox():return:
get_fsspec_kwargs()
def get_fsspec_kwargs(
anonymous: bool,
kwargs,
) -> typing.Dict[str, typing.Any]Returns the configuration as kwargs for constructing an fsspec filesystem.
| Parameter | Type | Description |
|---|---|---|
anonymous |
bool |
|
kwargs |
**kwargs |