interface OAuth2ClientCredentialConfigurationProperty

Language	Type name
.NET	Amazon.CDK.aws_qbusiness.CfnPlugin.OAuth2ClientCredentialConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsqbusiness#CfnPlugin_OAuth2ClientCredentialConfigurationProperty
Java	software.amazon.awscdk.services.qbusiness.CfnPlugin.OAuth2ClientCredentialConfigurationProperty
Python	aws_cdk.aws_qbusiness.CfnPlugin.OAuth2ClientCredentialConfigurationProperty
TypeScript	aws-cdk-lib » aws_qbusiness » CfnPlugin » OAuth2ClientCredentialConfigurationProperty

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

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

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';
const oAuth2ClientCredentialConfigurationProperty: qbusiness.CfnPlugin.OAuth2ClientCredentialConfigurationProperty = {
  roleArn: 'roleArn',
  secretArn: 'secretArn',

  // the properties below are optional
  authorizationUrl: 'authorizationUrl',
  tokenUrl: 'tokenUrl',
};

Properties

Name	Type	Description
roleArn	string	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	string	The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
authorizationUrl?	string	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.
tokenUrl?	string	The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.

---

roleArn

Type: string

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.

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

---

secretArn

Type: string

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

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

---

authorizationUrl?

Type: string (optional)

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.

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

---

tokenUrl?

Type: string (optional)

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

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