AWS::QBusiness::Plugin OAuth2ClientCredentialConfiguration - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::QBusiness::Plugin OAuth2ClientCredentialConfiguration

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "AuthorizationUrl" : String,
  "RoleArn" : String,
  "SecretArn" : String,
  "TokenUrl" : String
}

YAML

  AuthorizationUrl: String
  RoleArn: String
  SecretArn: String
  TokenUrl: String

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.

Required: No

Type: String

Pattern: ^(https?|ftp|file)://([^\s]*)$

Minimum: 1

Maximum: 2048

Update requires: No interruption

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.

Required: Yes

Type: String

Pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$

Minimum: 0

Maximum: 1284

Update requires: No interruption

SecretArn

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

Required: Yes

Type: String

Pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$

Minimum: 0

Maximum: 1284

Update requires: No interruption

TokenUrl

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

Required: No

Type: String

Pattern: ^(https?|ftp|file)://([^\s]*)$

Minimum: 1

Maximum: 2048

Update requires: No interruption