interface PluginAuthConfigurationProperty
| Language | Type name |
|---|---|
.NET | Amazon.CDK.Mixins.Preview.AWS.QBusiness.Mixins.CfnPluginPropsMixin.PluginAuthConfigurationProperty |
Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsqbusiness/mixins#CfnPluginPropsMixin_PluginAuthConfigurationProperty |
Java | software.amazon.awscdk.mixins.preview.services.qbusiness.mixins.CfnPluginPropsMixin.PluginAuthConfigurationProperty |
Python | aws_cdk.mixins_preview.aws_qbusiness.mixins.CfnPluginPropsMixin.PluginAuthConfigurationProperty |
TypeScript | @aws-cdk/mixins-preview » aws_qbusiness » mixins » CfnPluginPropsMixin » 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 { mixins as qbusiness_mixins } from '@aws-cdk/mixins-preview/aws-qbusiness';
declare const noAuthConfiguration: any;
const pluginAuthConfigurationProperty: qbusiness_mixins.CfnPluginPropsMixin.PluginAuthConfigurationProperty = {
basicAuthConfiguration: {
roleArn: 'roleArn',
secretArn: 'secretArn',
},
noAuthConfiguration: noAuthConfiguration,
oAuth2ClientCredentialConfiguration: {
authorizationUrl: 'authorizationUrl',
roleArn: 'roleArn',
secretArn: 'secretArn',
tokenUrl: 'tokenUrl',
},
};
Properties
| Name | Type | Description |
|---|---|---|
| basic | IResolvable | Basic | Information about the basic authentication credentials used to configure a plugin. |
| no | any | Information about invoking a custom plugin without any authentication. |
| o | IResolvable | OAuth2 | Information about the OAuth 2.0 authentication credential/token used to configure a plugin. |
basicAuthConfiguration?
Type:
IResolvable | Basic
(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 | OAuth2
(optional)
Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

.NET
Go
Java
Python
TypeScript