Package software.amazon.awscdk.services.qbusiness

Interface CfnPlugin.PluginAuthConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlugin.PluginAuthConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnPlugin

@Stability(Stable)
public static interface CfnPlugin.PluginAuthConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Authentication configuration information for an Amazon Q Business plugin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.qbusiness.*;
 Object noAuthConfiguration;
 PluginAuthConfigurationProperty pluginAuthConfigurationProperty = PluginAuthConfigurationProperty.builder()
         .basicAuthConfiguration(BasicAuthConfigurationProperty.builder()
                 .roleArn("roleArn")
                 .secretArn("secretArn")
                 .build())
         .noAuthConfiguration(noAuthConfiguration)
         .oAuth2ClientCredentialConfiguration(OAuth2ClientCredentialConfigurationProperty.builder()
                 .roleArn("roleArn")
                 .secretArn("secretArn")
                 // the properties below are optional
                 .authorizationUrl("authorizationUrl")
                 .tokenUrl("tokenUrl")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPlugin.PluginAuthConfigurationProperty.Builder	A builder for CfnPlugin.PluginAuthConfigurationProperty
static final class	CfnPlugin.PluginAuthConfigurationProperty.Jsii$Proxy	An implementation for CfnPlugin.PluginAuthConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnPlugin.PluginAuthConfigurationProperty.Builder	builder()
default Object	getBasicAuthConfiguration()	Information about the basic authentication credentials used to configure a plugin.
default Object	getNoAuthConfiguration()	Information about invoking a custom plugin without any authentication.
default Object	getOAuth2ClientCredentialConfiguration()	Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBasicAuthConfiguration

@Stability(Stable)
@Nullable
default Object getBasicAuthConfiguration()

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

Returns union: either IResolvable or CfnPlugin.BasicAuthConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html#cfn-qbusiness-plugin-pluginauthconfiguration-basicauthconfiguration

getNoAuthConfiguration

@Stability(Stable)
@Nullable
default Object getNoAuthConfiguration()

Information about invoking a custom plugin without any authentication.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html#cfn-qbusiness-plugin-pluginauthconfiguration-noauthconfiguration

getOAuth2ClientCredentialConfiguration

@Stability(Stable)
@Nullable
default Object getOAuth2ClientCredentialConfiguration()

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

Returns union: either IResolvable or CfnPlugin.OAuth2ClientCredentialConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html#cfn-qbusiness-plugin-pluginauthconfiguration-oauth2clientcredentialconfiguration

builder

@Stability(Stable)
static CfnPlugin.PluginAuthConfigurationProperty.Builder builder()

Returns:

a CfnPlugin.PluginAuthConfigurationProperty.Builder of CfnPlugin.PluginAuthConfigurationProperty