Interface CfnPlugin.IOAuth2ClientCredentialConfigurationProperty

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

Namespace: Amazon.CDK.AWS.QBusiness

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnPlugin.IOAuth2ClientCredentialConfigurationProperty

Syntax (vb)

Public Interface CfnPlugin.IOAuth2ClientCredentialConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.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 oAuth2ClientCredentialConfigurationProperty = new OAuth2ClientCredentialConfigurationProperty {
                 RoleArn = "roleArn",
                 SecretArn = "secretArn",

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

Synopsis

Properties

AuthorizationUrl	The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.
RoleArn	The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
SecretArn	The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
TokenUrl	The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.

Properties

AuthorizationUrl

The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.

string? AuthorizationUrl { get; }

Property Value

string

Remarks

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

RoleArn

The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

string RoleArn { get; }

Property Value

string

Remarks

SecretArn

The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

string SecretArn { get; }

Property Value

string

Remarks

TokenUrl

The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.

string? TokenUrl { get; }

Property Value

string