qbusiness/aws.sdk.kotlin.services.qbusiness.model/PluginAuthConfiguration

PluginAuthConfiguration

sealed class PluginAuthConfiguration

Authentication configuration information for an Amazon Q Business plugin.

Inheritors

BasicAuthConfiguration

IdcAuthConfiguration

NoAuthConfiguration

OAuth2ClientCredentialConfiguration

SdkUnknown

Types

BasicAuthConfiguration

data class BasicAuthConfiguration(val value: BasicAuthConfiguration) : PluginAuthConfiguration

Information about the basic authentication credentials used to configure a plugin.

IdcAuthConfiguration

data class IdcAuthConfiguration(val value: IdcAuthConfiguration) : PluginAuthConfiguration

Information about the IAM Identity Center Application used to configure authentication for a plugin.

NoAuthConfiguration

data class NoAuthConfiguration(val value: NoAuthConfiguration) : PluginAuthConfiguration

Information about invoking a custom plugin without any authentication.

OAuth2ClientCredentialConfiguration

data class OAuth2ClientCredentialConfiguration(val value: OAuth2ClientCredentialConfiguration) : PluginAuthConfiguration

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

SdkUnknown

object SdkUnknown : PluginAuthConfiguration

Functions

asBasicAuthConfiguration

fun asBasicAuthConfiguration(): BasicAuthConfiguration

Casts this PluginAuthConfiguration as a BasicAuthConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.BasicAuthConfiguration value. Throws an exception if the PluginAuthConfiguration is not a BasicAuthConfiguration.

asBasicAuthConfigurationOrNull

fun asBasicAuthConfigurationOrNull(): BasicAuthConfiguration?

Casts this PluginAuthConfiguration as a BasicAuthConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.BasicAuthConfiguration value. Returns null if the PluginAuthConfiguration is not a BasicAuthConfiguration.

asIdcAuthConfiguration

fun asIdcAuthConfiguration(): IdcAuthConfiguration

Casts this PluginAuthConfiguration as a IdcAuthConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.IdcAuthConfiguration value. Throws an exception if the PluginAuthConfiguration is not a IdcAuthConfiguration.

asIdcAuthConfigurationOrNull

fun asIdcAuthConfigurationOrNull(): IdcAuthConfiguration?

Casts this PluginAuthConfiguration as a IdcAuthConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.IdcAuthConfiguration value. Returns null if the PluginAuthConfiguration is not a IdcAuthConfiguration.

asNoAuthConfiguration

fun asNoAuthConfiguration(): NoAuthConfiguration

Casts this PluginAuthConfiguration as a NoAuthConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.NoAuthConfiguration value. Throws an exception if the PluginAuthConfiguration is not a NoAuthConfiguration.

asNoAuthConfigurationOrNull

fun asNoAuthConfigurationOrNull(): NoAuthConfiguration?

Casts this PluginAuthConfiguration as a NoAuthConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.NoAuthConfiguration value. Returns null if the PluginAuthConfiguration is not a NoAuthConfiguration.

asOAuth2ClientCredentialConfiguration

fun asOAuth2ClientCredentialConfiguration(): OAuth2ClientCredentialConfiguration

Casts this PluginAuthConfiguration as a OAuth2ClientCredentialConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.OAuth2ClientCredentialConfiguration value. Throws an exception if the PluginAuthConfiguration is not a OAuth2ClientCredentialConfiguration.

asOAuth2ClientCredentialConfigurationOrNull

fun asOAuth2ClientCredentialConfigurationOrNull(): OAuth2ClientCredentialConfiguration?

Casts this PluginAuthConfiguration as a OAuth2ClientCredentialConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.OAuth2ClientCredentialConfiguration value. Returns null if the PluginAuthConfiguration is not a OAuth2ClientCredentialConfiguration.