interface ConfluenceConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.Kendra.CfnDataSource.ConfluenceConfigurationProperty
Java	software.amazon.awscdk.services.kendra.CfnDataSource.ConfluenceConfigurationProperty
Python	aws_cdk.aws_kendra.CfnDataSource.ConfluenceConfigurationProperty
TypeScript	@aws-cdk/aws-kendra » CfnDataSource » ConfluenceConfigurationProperty

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as kendra from '@aws-cdk/aws-kendra';
const confluenceConfigurationProperty: kendra.CfnDataSource.ConfluenceConfigurationProperty = {
  secretArn: 'secretArn',
  serverUrl: 'serverUrl',
  version: 'version',

  // the properties below are optional
  attachmentConfiguration: {
    attachmentFieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      indexFieldName: 'indexFieldName',

      // the properties below are optional
      dateFieldFormat: 'dateFieldFormat',
    }],
    crawlAttachments: false,
  },
  blogConfiguration: {
    blogFieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      indexFieldName: 'indexFieldName',

      // the properties below are optional
      dateFieldFormat: 'dateFieldFormat',
    }],
  },
  exclusionPatterns: ['exclusionPatterns'],
  inclusionPatterns: ['inclusionPatterns'],
  pageConfiguration: {
    pageFieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      indexFieldName: 'indexFieldName',

      // the properties below are optional
      dateFieldFormat: 'dateFieldFormat',
    }],
  },
  spaceConfiguration: {
    crawlArchivedSpaces: false,
    crawlPersonalSpaces: false,
    excludeSpaces: ['excludeSpaces'],
    includeSpaces: ['includeSpaces'],
    spaceFieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      indexFieldName: 'indexFieldName',

      // the properties below are optional
      dateFieldFormat: 'dateFieldFormat',
    }],
  },
  vpcConfiguration: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
};

Properties

Name	Type	Description
secretArn	string	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.
serverUrl	string	The URL of your Confluence instance.
version	string	The version or the type of Confluence installation to connect to.
attachmentConfiguration?	IResolvable | ConfluenceAttachmentConfigurationProperty	Configuration information for indexing attachments to Confluence blogs and pages.
blogConfiguration?	IResolvable | ConfluenceBlogConfigurationProperty	Configuration information for indexing Confluence blogs.
exclusionPatterns?	string[]	A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence.
inclusionPatterns?	string[]	A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence.
pageConfiguration?	IResolvable | ConfluencePageConfigurationProperty	Configuration information for indexing Confluence pages.
spaceConfiguration?	IResolvable | ConfluenceSpaceConfigurationProperty	Configuration information for indexing Confluence spaces.
vpcConfiguration?	IResolvable | DataSourceVpcConfigurationProperty	Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence.

---

secretArn

Type: string

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 .

---

serverUrl

Type: string

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

---

version

Type: string

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

---

attachmentConfiguration?

Type: IResolvable | ConfluenceAttachmentConfigurationProperty (optional)

Configuration information for indexing attachments to Confluence blogs and pages.

---

blogConfiguration?

Type: IResolvable | ConfluenceBlogConfigurationProperty (optional)

Configuration information for indexing Confluence blogs.

---

exclusionPatterns?

Type: string[] (optional)

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.

---

inclusionPatterns?

Type: string[] (optional)

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.

---

pageConfiguration?

Type: IResolvable | ConfluencePageConfigurationProperty (optional)

Configuration information for indexing Confluence pages.

---

spaceConfiguration?

Type: IResolvable | ConfluenceSpaceConfigurationProperty (optional)

Configuration information for indexing Confluence spaces.

---

vpcConfiguration?

Type: IResolvable | DataSourceVpcConfigurationProperty (optional)

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence.

For more information, see Configuring a VPC .