interface PluginAuthConfigurationProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.aws_qbusiness.CfnPlugin.PluginAuthConfigurationProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsqbusiness#CfnPlugin_PluginAuthConfigurationProperty |
![]() | software.amazon.awscdk.services.qbusiness.CfnPlugin.PluginAuthConfigurationProperty |
![]() | aws_cdk.aws_qbusiness.CfnPlugin.PluginAuthConfigurationProperty |
![]() | 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 |
---|---|---|
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.