AWS::Kendra::DataSource ConfluenceConfiguration

Provides the configuration information to connect to Confluence as your data source.

Syntax

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

JSON

{
  "AttachmentConfiguration" : ConfluenceAttachmentConfiguration,
  "BlogConfiguration" : ConfluenceBlogConfiguration,
  "ExclusionPatterns" : [ String, ... ],
  "InclusionPatterns" : [ String, ... ],
  "PageConfiguration" : ConfluencePageConfiguration,
  "SecretArn" : String,
  "ServerUrl" : String,
  "SpaceConfiguration" : ConfluenceSpaceConfiguration,
  "Version" : String,
  "VpcConfiguration" : DataSourceVpcConfiguration
}

YAML

  AttachmentConfiguration: 
    ConfluenceAttachmentConfiguration
  BlogConfiguration: 
    ConfluenceBlogConfiguration
  ExclusionPatterns: 
    - String
  InclusionPatterns: 
    - String
  PageConfiguration: 
    ConfluencePageConfiguration
  SecretArn: String
  ServerUrl: String
  SpaceConfiguration: 
    ConfluenceSpaceConfiguration
  Version: String
  VpcConfiguration: 
    DataSourceVpcConfiguration

Properties

AttachmentConfiguration

Configuration information for indexing attachments to Confluence blogs and pages.

Required: No

Type: ConfluenceAttachmentConfiguration

Update requires: No interruption

BlogConfiguration

Configuration information for indexing Confluence blogs.

Required: No

Type: ConfluenceBlogConfiguration

Update requires: No interruption

ExclusionPatterns

A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

Required: No

Type: Array of String

Minimum: 1

Maximum: 50 | 100

Update requires: No interruption

InclusionPatterns

A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

Required: No

Type: Array of String

Minimum: 1

Maximum: 50 | 100

Update requires: No interruption

PageConfiguration

Configuration information for indexing Confluence pages.

Required: No

Type: ConfluencePageConfiguration

Update requires: No interruption

SecretArn

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence Cloud, you use a generated API token as the password.

You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source.

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: 1

Maximum: 1284

Update requires: No interruption

ServerUrl

The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 2048

Update requires: No interruption

SpaceConfiguration

Configuration information for indexing Confluence spaces.

Required: No

Type: ConfluenceSpaceConfiguration

Update requires: No interruption

Version

The version or the type of Confluence installation to connect to.

Required: Yes

Type: String

Allowed values: CLOUD | SERVER

Update requires: No interruption

VpcConfiguration

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.

Required: No

Type: DataSourceVpcConfiguration

Update requires: No interruption