AWS::Kendra::DataSource ConfluenceConfiguration - AWS CloudFormation

AWS::Kendra::DataSource ConfluenceConfiguration

Provides configuration information for data sources that connect to Confluence.

Syntax

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

Properties

AttachmentConfiguration

Specifies configuration information for indexing attachments to Confluence blogs and pages.

Required: No

Type: ConfluenceAttachmentConfiguration

Update requires: No interruption

BlogConfiguration

Specifies configuration information for indexing Confluence blogs.

Required: No

Type: ConfluenceBlogConfiguration

Update requires: No interruption

ExclusionPatterns

A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.

Required: No

Type: List of String

Maximum: 100

Update requires: No interruption

InclusionPatterns

A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.

Required: No

Type: List of String

Maximum: 100

Update requires: No interruption

PageConfiguration

Specifies 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 key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:

  • username - The user name or email address of a user with administrative privileges for the Confluence server.

  • password - The password associated with the user logging in to the Confluence server.

Required: Yes

Type: String

Minimum: 1

Maximum: 1284

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

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

Minimum: 1

Maximum: 2048

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

Update requires: No interruption

SpaceConfiguration

Specifies configuration information for indexing Confluence spaces.

Required: No

Type: ConfluenceSpaceConfiguration

Update requires: No interruption

Version

Specifies the version of the Confluence installation that you are connecting to.

Required: Yes

Type: String

Allowed values: CLOUD | SERVER

Update requires: No interruption

VpcConfiguration

Specifies the information for connecting to an Amazon VPC.

Required: No

Type: DataSourceVpcConfiguration

Update requires: No interruption