Skip to main content

S3

S3 specific configuration.

Attributes

AttributeTypeDescription
endpointstring = nullCustom URL for the S3-compatible service endpoint used to override the default AWS service URL.
access_key_idstring = nullStatic AWS access key ID used for explicit authentication with the S3 storage provider.
secret_access_keystring = nullStatic AWS secret access key used for explicit authentication with the S3 storage provider.
regionstring = nullAWS region identifier used to specify the geographic location of the S3 bucket.
addressing_stylestring = nullS3 bucket addressing strategy, where a value of 'virtual' enables virtual-hosted style requests.

Methods


auto()

@classmethod
def auto(
region: str | None = None
) - > [S3](s3.md?sid=flyte_storage__config_s3)

:return: Config

Parameters

NameTypeDescription
region`strNone` = None

Returns

TypeDescription
[S3](s3.md?sid=flyte_storage__config_s3)An S3 configuration object initialized from environment variables and the provided region.

for_sandbox()

@classmethod
def for_sandbox() - > [S3](s3.md?sid=flyte_storage__config_s3)

:return:

Returns

TypeDescription
[S3](s3.md?sid=flyte_storage__config_s3)An S3 configuration object pre-configured with local Minio credentials and endpoint for sandbox environments.

get_fsspec_kwargs()

@classmethod
def get_fsspec_kwargs(
anonymous: bool = False,
**kwargs: Any
) - > typing.Dict[str, typing.Any]

Constructs a dictionary of configuration arguments for fsspec or obstore, resolving credentials from static keys or AWS config files.

Parameters

NameTypeDescription
anonymousbool = FalseWhether to connect without using any authentication credentials.
**kwargsAnyAdditional keyword arguments to be merged into the resulting configuration.

Returns

TypeDescription
typing.Dict[str, typing.Any]A dictionary containing authentication, endpoint, and region settings for S3 storage backends.