BREAKING: Service client HTTP engine selection

[ianbotsf]

An upcoming release of the AWS SDK for Kotlin renames the config parameter for selecting an HTTP engine in service clients and credentials providers. This change streamlines naming and decreases verbosity but may affect some existing code.

Note: If you do not manually configure an HTTP engine for SDK service clients or credentials providers then this change should not affect you.

Release date

This feature will ship with the v0.25.0-beta release planned for 5/18/2023.

What's changing

The service client config parameter for selecting a non-default HTTP engine instance is changing from httpClientEngine to simply httpClient. Various credentials providers which accept an HTTP engine are also changing the name of that parameter from httpClientEngine to httpClient.

How to migrate

Migration steps depend on the current use case:

Service client config

Previously, SDK service clients could be configured to accept an HTTP engine like this:

val someOkHttpInstance = OkHttpEngine { ... }
val s3 = S3Client.fromEnvironment {
    httpClientEngine = someOkHttpInstance
}

After this change, the engine instance will be configured like this:

val someOkHttpInstance = OkHttpEngine { ... }
val s3 = S3Client.fromEnvironment {
    httpClient = someOkHttpInstance
}

Credentials providers

Previously, some credentials providers (e.g., the default chain provider) could be configured to accept an HTTP engine like this:

val someOkHttpInstance = OkHttpEngine { ... }
val credsProvider = DefaultChainCredentialsProvider(
    httpClientEngine = someOkHttpInstance
)

After this change, the engine instance will be configured like this:

val someOkHttpInstance = OkHttpEngine { ... }
val credsProvider = DefaultChainCredentialsProvider(
    httpClient = someOkHttpInstance
)

Additional resources

If you have any questions concerning this change, please feel free to engage with us in this discussion. If you encounter a bug with these changes, please file an issue.