2.233.0

interface OAuth2ClientCredentialConfigurationProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.QBusiness.Mixins.CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsqbusiness/mixins#CfnPluginPropsMixin_OAuth2ClientCredentialConfigurationProperty
Javasoftware.amazon.awscdk.mixins.preview.services.qbusiness.mixins.CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty
Pythonaws_cdk.mixins_preview.aws_qbusiness.mixins.CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty
TypeScript @aws-cdk/mixins-preview » aws_qbusiness » mixins » CfnPluginPropsMixin » 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 { mixins as qbusiness_mixins } from '@aws-cdk/mixins-preview/aws-qbusiness';
const oAuth2ClientCredentialConfigurationProperty: qbusiness_mixins.CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty = {
  authorizationUrl: 'authorizationUrl',
  roleArn: 'roleArn',
  secretArn: 'secretArn',
  tokenUrl: 'tokenUrl',
};

Properties

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

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

roleArn?

Type: string (optional)

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 (optional)

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

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

← PreviousNext →