commonMain.aws.sdk.kotlin.crt.auth.credentials.DefaultChainCredentialsProvider.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-crt-kotlin-android Show documentation

Kotlin Multiplatform bindings for AWS SDK Common Runtime

There is a newer version: 0.8.9

Show newest version

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

package aws.sdk.kotlin.crt.auth.credentials

import aws.sdk.kotlin.crt.io.ClientBootstrap

/**
 * Creates the default provider chain used by most AWS SDKs.
 *
 * Generally:
 *
 * (1) Environment
 * (2) Profile
 * (3) (conditional, off by default) ECS
 * (4) (conditional, on by default) EC2 Instance Metadata
 *
 * Support for environmental control of the default provider chain is not yet
 * implemented.
 *
 * @return the newly-constructed credentials provider
 */
public expect class DefaultChainCredentialsProvider internal constructor(builder: DefaultChainCredentialsProviderBuilder) : CredentialsProvider {

    public companion object { }

    override fun close()
    override suspend fun getCredentials(): Credentials
    override suspend fun waitForShutdown()
}

public class DefaultChainCredentialsProviderBuilder {
    public var clientBootstrap: ClientBootstrap? = null

    public fun build(): DefaultChainCredentialsProvider {
        requireNotNull(clientBootstrap) { "DefaultChainCredentialsProvider: clientBootstrap must be provided" }
        return DefaultChainCredentialsProvider(this)
    }
}

/**
 * Construct a new credentials provider using a builder
 */
public fun DefaultChainCredentialsProvider.Companion.build(block: DefaultChainCredentialsProviderBuilder.() -> Unit): DefaultChainCredentialsProvider = DefaultChainCredentialsProviderBuilder().apply(block).build()