AWS::QBusiness::Plugin PluginAuthConfiguration

Authentication configuration information for an Amazon Q Business plugin.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "BasicAuthConfiguration" : BasicAuthConfiguration,
  "NoAuthConfiguration" : Json,
  "OAuth2ClientCredentialConfiguration" : OAuth2ClientCredentialConfiguration
}

YAML

  BasicAuthConfiguration: 
    BasicAuthConfiguration
  NoAuthConfiguration: Json
  OAuth2ClientCredentialConfiguration: 
    OAuth2ClientCredentialConfiguration

Properties

BasicAuthConfiguration

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

Required: No

Type: BasicAuthConfiguration

Update requires: No interruption

NoAuthConfiguration

Information about invoking a custom plugin without any authentication.

Required: No

Type: Json

Update requires: No interruption

OAuth2ClientCredentialConfiguration

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

Required: No

Type: OAuth2ClientCredentialConfiguration

Update requires: No interruption