ConfluenceConfiguration - Amazon Kendra

ConfluenceConfiguration

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

Contents

AttachmentConfiguration

Configuration information for indexing attachments to Confluence blogs and pages.

Type: ConfluenceAttachmentConfiguration object

Required: No

BlogConfiguration

Configuration information for indexing Confluence blogs.

Type: ConfluenceBlogConfiguration object

Required: No

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.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 150.

Required: No

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.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 150.

Required: No

PageConfiguration

Configuration information for indexing Confluence pages.

Type: ConfluencePageConfiguration object

Required: No

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. For more information, see Using a Confluence data source.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 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}

Required: Yes

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/.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

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

Required: Yes

SpaceConfiguration

Configuration information for indexing Confluence spaces.

Type: ConfluenceSpaceConfiguration object

Required: No

Version

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

Type: String

Valid Values: CLOUD | SERVER

Required: Yes

VpcConfiguration

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

Type: DataSourceVpcConfiguration object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: