aws-credentials/aws.smithy.kotlin.runtime.auth.awscredentials/CloseableCredentialsProvider

CloseableCredentialsProvider

interface CloseableCredentialsProvider : CredentialsProvider, Closeable

A CredentialsProvider with Closeable resources. Users SHOULD call close when done with the provider to ensure any held resources are properly released.

Implementations MUST evict any previously-retrieved or stored credentials when the provider is closed.

Inheritors

CachedCredentialsProvider

Inherited properties

simpleClassName

val CredentialsProvider.simpleClassName: String

Retrieves the simple name of the class implementing CredentialsProvider.

Inherited functions

cached

fun CredentialsProvider.cached(expireCredentialsAfter: Duration = DEFAULT_CREDENTIALS_REFRESH_SECONDS.seconds, refreshBufferWindow: Duration = DEFAULT_CREDENTIALS_REFRESH_BUFFER_SECONDS.seconds, clock: Clock = Clock.System): CachedCredentialsProvider

A utility function which wraps a CredentialsProvider in a CachedCredentialsProvider.

expect abstract fun close()

resolve

abstract suspend override fun resolve(attributes: Attributes): Credentials

Request credentials from the provider