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

Package-level declarations

Types

class CachedCredentialsProvider(source: CredentialsProvider, expireCredentialsAfter: <Error class: unknown class> = DEFAULT_CREDENTIALS_REFRESH_SECONDS.seconds, refreshBufferWindow: <Error class: unknown class> = DEFAULT_CREDENTIALS_REFRESH_BUFFER_SECONDS.seconds, clock: <Error class: unknown class> = Clock.System) : CloseableCredentialsProvider

Creates a provider that functions as a caching decorator of another provider.

CloseableCredentialsProvider

interface CloseableCredentialsProvider : CredentialsProvider

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

Credentials

interface Credentials

Represents a set of AWS credentials

CredentialsProvider

interface CredentialsProvider

Represents a producer/source of AWS credentials

CredentialsProviderChain

class CredentialsProviderChain(providers: CredentialsProvider) : CredentialsProvider

Composite CredentialsProvider that delegates to a chain of providers. When asked for credentials, providers are consulted in the order given until one succeeds. If none of the providers in the chain can provide credentials then this class will throw an exception. The exception will include the providers tried in the message. Each individual exception is available as a suppressed exception.

CredentialsProviderConfig

interface CredentialsProviderConfig

The user-accessible configuration properties for configuring a CredentialsProvider.

CredentialsProviderException

class CredentialsProviderException(message: String, cause: Throwable? = null)

The CredentialsProvider experienced an error during credentials resolution

SigV4aClientConfig

interface SigV4aClientConfig

The configuration properties for a client that supports SigV4a

Properties

DEFAULT_CREDENTIALS_REFRESH_SECONDS

const val DEFAULT_CREDENTIALS_REFRESH_SECONDS: Int

The amount of time credentials are valid for before being refreshed when an explicit value is not given to/from a provider

Inherited properties

simpleClassName

val CredentialsProvider.simpleClassName: String

Retrieves the simple name of the class implementing CredentialsProvider.

Inherited functions

cached

fun CredentialsProvider.cached(expireCredentialsAfter: <Error class: unknown class> = DEFAULT_CREDENTIALS_REFRESH_SECONDS.seconds, refreshBufferWindow: <Error class: unknown class> = DEFAULT_CREDENTIALS_REFRESH_BUFFER_SECONDS.seconds, clock: <Error class: unknown class> = Clock.System): CachedCredentialsProvider

A utility function which wraps a CredentialsProvider in a CachedCredentialsProvider.

copy

fun Credentials.copy(accessKeyId: String = this.accessKeyId, secretAccessKey: String = this.secretAccessKey, sessionToken: String? = this.sessionToken, expiration: <Error class: unknown class>? = this.expiration, providerName: String? = this.providerName, attributes: <Error class: unknown class>? = this.attributes): Credentials