SDK reference

First-party fakecloud SDKs for TypeScript, Python, Go, PHP, Java, and Rust.

fakecloud ships first-party SDKs in six languages for test assertions and simulation control. Each SDK wraps the /_fakecloud/* introspection and configuration endpoints into ergonomic helpers that fit the language's testing idioms.

These SDKs are not the AWS SDK. Your application code still talks to fakecloud through the normal AWS SDK (boto3, aws-sdk-js, aws-sdk-rust, etc.) — the fakecloud SDK is what your tests use to assert on what happened.

Which SDK?

LanguageInstallPage
TypeScriptnpm install fakecloudTypeScript SDK
Pythonpip install fakecloudPython SDK
Gogo get github.com/faiscadev/fakecloud/sdks/goGo SDK
PHPcomposer require fakecloud/fakecloudPHP SDK
Javadev.fakecloud:fakecloud:0.9.2Java SDK
Rustcargo add fakecloud-sdkRust SDK

Common surface

All six SDKs cover the same core surface:

  • Reset: reset() and resetService(service) to clear state between tests
  • Health: verify fakecloud is reachable
  • Per-service introspection: get recorded messages, emails, invocations, events
  • Simulation and processor ticks: drive time-dependent behavior on demand (TTL expiration, secret rotation, S3 lifecycle)
  • Bedrock test harness: response configuration, fault injection, call history

The method names differ across languages to match each language's idiom (camelCase for TS/JS, Java, and PHP, snake_case for Python, PascalCase for Go, snake_case for Rust), but the behavior is the same.

Pages

  • TypeScript SDK — Install and use the fakecloud SDK for TypeScript and JavaScript tests.
  • Python SDK — Install and use the fakecloud SDK for Python tests (sync and async).
  • Go SDK — Install and use the fakecloud SDK for Go tests.
  • Java SDK — Install and use the fakecloud SDK for JVM tests (JUnit, Spring Boot, Micronaut, Quarkus).
  • PHP SDK — Install and use the fakecloud SDK for PHP tests (PHPUnit, Pest, Laravel, Symfony).
  • Rust SDK — Install and use the fakecloud SDK for Rust tests.