interface PluginAuthConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.aws_qbusiness.CfnPlugin.PluginAuthConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsqbusiness#CfnPlugin_PluginAuthConfigurationProperty`
Java	`software.amazon.awscdk.services.qbusiness.CfnPlugin.PluginAuthConfigurationProperty`
Python	`aws_cdk.aws_qbusiness.CfnPlugin.PluginAuthConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_qbusiness` » `CfnPlugin` » `PluginAuthConfigurationProperty`

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 { aws_qbusiness as qbusiness } from 'aws-cdk-lib';

declare const noAuthConfiguration: any;
const pluginAuthConfigurationProperty: qbusiness.CfnPlugin.PluginAuthConfigurationProperty = {
  basicAuthConfiguration: {
    roleArn: 'roleArn',
    secretArn: 'secretArn',
  },
  noAuthConfiguration: noAuthConfiguration,
  oAuth2ClientCredentialConfiguration: {
    roleArn: 'roleArn',
    secretArn: 'secretArn',

    // the properties below are optional
    authorizationUrl: 'authorizationUrl',
    tokenUrl: 'tokenUrl',
  },
};

Properties

Name	Type	Description
basicAuthConfiguration?	`IResolvable` `\|` `BasicAuthConfigurationProperty`	Information about the basic authentication credentials used to configure a plugin.
noAuthConfiguration?	`any`	Information about invoking a custom plugin without any authentication.
oAuth2ClientCredentialConfiguration?	`IResolvable` `\|` `OAuth2ClientCredentialConfigurationProperty`	Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

basicAuthConfiguration?

Type: IResolvable | BasicAuthConfigurationProperty (optional)

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

noAuthConfiguration?

Type: any (optional)

Information about invoking a custom plugin without any authentication.

oAuth2ClientCredentialConfiguration?

Type: IResolvable | OAuth2ClientCredentialConfigurationProperty (optional)

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