bedrockagentcorecontrol/aws.sdk.kotlin.services.bedrockagentcorecontrol.model/CredentialProvider

CredentialProvider

sealed class CredentialProvider

A credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint.

Inheritors

ApiKeyCredentialProvider

IamCredentialProvider

OauthCredentialProvider

Types

ApiKeyCredentialProvider

data class ApiKeyCredentialProvider(val value: GatewayApiKeyCredentialProvider) : CredentialProvider

The API key credential provider. This provider uses an API key to authenticate with the target endpoint.

IamCredentialProvider

data class IamCredentialProvider(val value: IamCredentialProvider) : CredentialProvider

The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.

OauthCredentialProvider

data class OauthCredentialProvider(val value: OAuthCredentialProvider) : CredentialProvider

The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.

object SdkUnknown : CredentialProvider

Functions

asApiKeyCredentialProvider

fun asApiKeyCredentialProvider(): GatewayApiKeyCredentialProvider

Casts this CredentialProvider as a ApiKeyCredentialProvider and retrieves its aws.sdk.kotlin.services.bedrockagentcorecontrol.model.GatewayApiKeyCredentialProvider value. Throws an exception if the CredentialProvider is not a ApiKeyCredentialProvider.

asApiKeyCredentialProviderOrNull

fun asApiKeyCredentialProviderOrNull(): GatewayApiKeyCredentialProvider?

Casts this CredentialProvider as a ApiKeyCredentialProvider and retrieves its aws.sdk.kotlin.services.bedrockagentcorecontrol.model.GatewayApiKeyCredentialProvider value. Returns null if the CredentialProvider is not a ApiKeyCredentialProvider.

asIamCredentialProvider

fun asIamCredentialProvider(): IamCredentialProvider

Casts this CredentialProvider as a IamCredentialProvider and retrieves its aws.sdk.kotlin.services.bedrockagentcorecontrol.model.IamCredentialProvider value. Throws an exception if the CredentialProvider is not a IamCredentialProvider.

asIamCredentialProviderOrNull

fun asIamCredentialProviderOrNull(): IamCredentialProvider?

Casts this CredentialProvider as a IamCredentialProvider and retrieves its aws.sdk.kotlin.services.bedrockagentcorecontrol.model.IamCredentialProvider value. Returns null if the CredentialProvider is not a IamCredentialProvider.

asOauthCredentialProvider

fun asOauthCredentialProvider(): OAuthCredentialProvider

Casts this CredentialProvider as a OauthCredentialProvider and retrieves its aws.sdk.kotlin.services.bedrockagentcorecontrol.model.OAuthCredentialProvider value. Throws an exception if the CredentialProvider is not a OauthCredentialProvider.

asOauthCredentialProviderOrNull

fun asOauthCredentialProviderOrNull(): OAuthCredentialProvider?

Casts this CredentialProvider as a OauthCredentialProvider and retrieves its aws.sdk.kotlin.services.bedrockagentcorecontrol.model.OAuthCredentialProvider value. Returns null if the CredentialProvider is not a OauthCredentialProvider.