Skip to content
v2.275.0

PluginAuthConfigurationProperty Struct ​

Authentication configuration information for an Amazon Q Business plugin.

Example ​

ts
// 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 ​

basicAuthConfigurationoptionalIResolvable | CfnPlugin.BasicAuthConfigurationPropertybasic_auth_configurationoptionaltyping.Union[IResolvable, BasicAuthConfigurationProperty]basicAuthConfigurationoptionalIResolvableBasicAuthConfigurationoptionalIResolvableBasicAuthConfigurationoptionalinterface{}#
Information about the basic authentication credentials used to configure a plugin.
noAuthConfigurationoptionalanyno_auth_configurationoptionalAnynoAuthConfigurationoptionalObjectNoAuthConfigurationoptionalobjectNoAuthConfigurationoptionalinterface{}#
Information about invoking a custom plugin without any authentication.
oAuth2ClientCredentialConfigurationoptionalIResolvable | CfnPlugin.OAuth2ClientCredentialConfigurationPropertyo_auth2_client_credential_configurationoptionaltyping.Union[IResolvable, OAuth2ClientCredentialConfigurationProperty]oAuth2ClientCredentialConfigurationoptionalIResolvableOAuth2ClientCredentialConfigurationoptionalIResolvableOAuth2ClientCredentialConfigurationoptionalinterface{}#
Information about the OAuth 2.0 authentication credential/token used to configure a plugin.