Interface CfnPlugin.IPluginAuthConfigurationProperty

Authentication configuration information for an Amazon Q Business plugin.

Namespace: Amazon.CDK.AWS.QBusiness

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnPlugin.IPluginAuthConfigurationProperty

Syntax (vb)

Public Interface CfnPlugin.IPluginAuthConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.QBusiness;

             var noAuthConfiguration;

             var pluginAuthConfigurationProperty = new PluginAuthConfigurationProperty {
                 BasicAuthConfiguration = new BasicAuthConfigurationProperty {
                     RoleArn = "roleArn",
                     SecretArn = "secretArn"
                 },
                 NoAuthConfiguration = noAuthConfiguration,
                 OAuth2ClientCredentialConfiguration = new OAuth2ClientCredentialConfigurationProperty {
                     RoleArn = "roleArn",
                     SecretArn = "secretArn",

                     // the properties below are optional
                     AuthorizationUrl = "authorizationUrl",
                     TokenUrl = "tokenUrl"
                 }
             };

Synopsis

Properties

BasicAuthConfiguration	Information about the basic authentication credentials used to configure a plugin.
NoAuthConfiguration	Information about invoking a custom plugin without any authentication.
OAuth2ClientCredentialConfiguration	Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

Properties

BasicAuthConfiguration

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

object? BasicAuthConfiguration { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html#cfn-qbusiness-plugin-pluginauthconfiguration-basicauthconfiguration

Type union: either IResolvable or CfnPlugin.IBasicAuthConfigurationProperty

NoAuthConfiguration

Information about invoking a custom plugin without any authentication.

object? NoAuthConfiguration { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html#cfn-qbusiness-plugin-pluginauthconfiguration-noauthconfiguration

OAuth2ClientCredentialConfiguration

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

object? OAuth2ClientCredentialConfiguration { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html#cfn-qbusiness-plugin-pluginauthconfiguration-oauth2clientcredentialconfiguration

Type union: either IResolvable or CfnPlugin.IOAuth2ClientCredentialConfigurationProperty