aws-cdk-lib.aws_qbusiness.CfnPlugin.OAuth2ClientCredentialConfigurationProperty

OAuth2ClientCredentialConfigurationProperty Struct

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

Source

Generated code

Type last changed

v2.173.0 · 12 Dec 2024

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

authorizationUrlstringauthorization_urlstrauthorizationUrlStringAuthorizationUrlstringAuthorizationUrl*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.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#

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.

secretArnstringsecret_arnstrsecretArnStringSecretArnstringSecretArn*stringrequired#

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

tokenUrlstringtoken_urlstrtokenUrlStringTokenUrlstringTokenUrl*string#

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