cayu.environments.aws_filesystems

Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.

EFSAccessPointBinding

from cayu.environments import EFSAccessPointBinding

Mount an IAM/access-point-scoped EFS workspace into a runner.

Bases: _AccessPointBinding.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
backend	class attribute	'efs'
filesystem_type	class attribute	'efs'

bind (method)

async EFSAccessPointBinding.bind(workspace: Workspace | None, runner: Runner | None, *, session_id: str, agent_name: str | None=None, environment_name: str | None=None, metadata: dict[str, Any] | None=None) -> BoundWorkspace

finalize (method)

async EFSAccessPointBinding.finalize(bound: BoundWorkspace, *, outcome: str | None=None, metadata: dict[str, Any] | None=None) -> WorkspaceSnapshot | None

observe_revision (method)

async EFSAccessPointBinding.observe_revision(bound: BoundWorkspace) -> WorkspaceRevisionObservation

Observe bounded workspace state when this binding supports it.

The compatibility default is an explicit unsupported result. It must not reinterpret per-file optimistic revision tokens or binding snapshots as restorable workspace revisions.

input_capability (method)

EFSAccessPointBinding.input_capability() -> ImmutableInputAdapterCapability

Describe how this binding exposes environment input bytes.

observe_writer_isolation (method)

EFSAccessPointBinding.observe_writer_isolation(bound: BoundWorkspace) -> WorkspaceWriterIsolationEvidence

Report inspectable writer-isolation evidence for one mutation window.

The compatibility default is deliberately unknown. Serial tool dispatch, a process-local lock, or a stable workspace identity does not prove that users, sibling processes, or background services cannot mutate the same resource.

abandon (method)

EFSAccessPointBinding.abandon(bound: BoundWorkspace) -> bool

Release process-local retry state when finalization will not run again.

Most bindings do not retain retry state, so the compatibility default is a validated no-op. Stateful bindings should override this method and release only state owned by bound. Return False only when the binding must retain its lifecycle owner for a later cleanup attempt.

init (method)

EFSAccessPointBinding.__init__(*, file_system_id: str, access_point_id: str, mount_target_ip: str, path: str='/workspace', workspace_id: str | None=None, mount_timeout_s: int=45, unmount_timeout_s: int=30) -> None

Release source · Runtime guarantees · Capability guides

S3FilesAccessPointBinding

from cayu.environments import S3FilesAccessPointBinding

Mount an access-point-scoped Amazon S3 File System workspace.

Bases: _AccessPointBinding.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
backend	class attribute	's3files'
filesystem_type	class attribute	's3files'

bind (method)

async S3FilesAccessPointBinding.bind(workspace: Workspace | None, runner: Runner | None, *, session_id: str, agent_name: str | None=None, environment_name: str | None=None, metadata: dict[str, Any] | None=None) -> BoundWorkspace

finalize (method)

async S3FilesAccessPointBinding.finalize(bound: BoundWorkspace, *, outcome: str | None=None, metadata: dict[str, Any] | None=None) -> WorkspaceSnapshot | None

observe_revision (method)

async S3FilesAccessPointBinding.observe_revision(bound: BoundWorkspace) -> WorkspaceRevisionObservation

Observe bounded workspace state when this binding supports it.

The compatibility default is an explicit unsupported result. It must not reinterpret per-file optimistic revision tokens or binding snapshots as restorable workspace revisions.

input_capability (method)

S3FilesAccessPointBinding.input_capability() -> ImmutableInputAdapterCapability

Describe how this binding exposes environment input bytes.

observe_writer_isolation (method)

S3FilesAccessPointBinding.observe_writer_isolation(bound: BoundWorkspace) -> WorkspaceWriterIsolationEvidence

Report inspectable writer-isolation evidence for one mutation window.

The compatibility default is deliberately unknown. Serial tool dispatch, a process-local lock, or a stable workspace identity does not prove that users, sibling processes, or background services cannot mutate the same resource.

abandon (method)

S3FilesAccessPointBinding.abandon(bound: BoundWorkspace) -> bool

Release process-local retry state when finalization will not run again.

Most bindings do not retain retry state, so the compatibility default is a validated no-op. Stateful bindings should override this method and release only state owned by bound. Return False only when the binding must retain its lifecycle owner for a later cleanup attempt.

init (method)

S3FilesAccessPointBinding.__init__(*, file_system_id: str, access_point_id: str, mount_target_ip: str, availability_zone_id: str, region_name: str, path: str='/workspace', workspace_id: str | None=None, mount_timeout_s: int=45, unmount_timeout_s: int=30) -> None

Release source · Runtime guarantees · Capability guides

WorkspaceMountError

from cayu.environments import WorkspaceMountError

A mounted workspace could not be established or released safely.

Bases: RuntimeError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides