http4k-connect-amazon-s3/org.http4k.connect.amazon.s3

Package-level declarations

Types

Link copied to clipboard
interface S3

Docs: https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html

Link copied to clipboard
interface S3Action<R> : Action<Result<R, RemoteFailure>>
Link copied to clipboard
interface S3Bucket

Interface for bucket-specific S3 operations

Link copied to clipboard
interface S3BucketAction<R> : Action<Result<R, RemoteFailure>>

Functions

Link copied to clipboard
fun S3.Companion.Http(env: Map<String, String> = getenv(), http: HttpHandler = JavaHttpClient(), clock: Clock = systemUTC(), credentialsProvider: CredentialsProvider = CredentialsProvider.Environment(env), overrideEndpoint: Uri? = null): S3

Convenience function to create a S3 from a System environment

fun S3.Companion.Http(env: Environment, http: HttpHandler = JavaHttpClient(), clock: Clock = systemUTC(), credentialsProvider: CredentialsProvider = CredentialsProvider.Environment(env), overrideEndpoint: Uri? = null): S3

Convenience function to create a S3 from an http4k Environment

fun S3.Companion.Http(credentialsProvider: CredentialsProvider, http: HttpHandler = JavaHttpClient(), clock: Clock = systemUTC(), payloadMode: Payload.Mode = Payload.Mode.Signed, overrideEndpoint: Uri? = null): S3

Standard HTTP implementation of S3

fun S3Bucket.Companion.Http(bucketName: BucketName, bucketRegion: Region, credentialsProvider: CredentialsProvider, http: HttpHandler = JavaHttpClient(), clock: Clock = Clock.systemUTC(), payloadMode: Payload.Mode = Payload.Mode.Signed, overrideEndpoint: Uri? = null, forcePathStyle: Boolean = false): S3Bucket

Standard HTTP implementation of S3Bucket

fun S3Bucket.Companion.Http(bucketName: BucketName, bucketRegion: Region, env: Map<String, String> = System.getenv(), http: HttpHandler = JavaHttpClient(), clock: Clock = Clock.systemUTC(), payloadMode: Payload.Mode = Payload.Mode.Signed, overrideEndpoint: Uri? = null, forcePathStyle: Boolean = false, credentialsProvider: CredentialsProvider = CredentialsProvider.Environment(env)): S3Bucket

Convenience function to create a S3Bucket from a System environment

fun S3Bucket.Companion.Http(bucketName: BucketName, bucketRegion: Region, env: Environment, http: HttpHandler = JavaHttpClient(), clock: Clock = Clock.systemUTC(), payloadMode: Payload.Mode = Payload.Mode.Signed, overrideEndpoint: Uri? = null, forcePathStyle: Boolean = false, credentialsProvider: CredentialsProvider = CredentialsProvider.Environment(env)): S3Bucket

Convenience function to create a S3Bucket from an http4k Environment