Skip to content
v2.278.0

ConfluenceConfigurationProperty Struct ​

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
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'],
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra

confluence_configuration_property = kendra.CfnDataSource.ConfluenceConfigurationProperty(
    secret_arn="secretArn",
    server_url="serverUrl",
    version="version",

    # the properties below are optional
    attachment_configuration=kendra.CfnDataSource.ConfluenceAttachmentConfigurationProperty(
        attachment_field_mappings=[kendra.CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty(
            data_source_field_name="dataSourceFieldName",
            index_field_name="indexFieldName",

            # the properties below are optional
            date_field_format="dateFieldFormat"
        )],
        crawl_attachments=False
    ),
    blog_configuration=kendra.CfnDataSource.ConfluenceBlogConfigurationProperty(
        blog_field_mappings=[kendra.CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty(
            data_source_field_name="dataSourceFieldName",
            index_field_name="indexFieldName",

            # the properties below are optional
            date_field_format="dateFieldFormat"
        )]
    ),
    exclusion_patterns=["exclusionPatterns"],
    inclusion_patterns=["inclusionPatterns"],
    page_configuration=kendra.CfnDataSource.ConfluencePageConfigurationProperty(
        page_field_mappings=[kendra.CfnDataSource.ConfluencePageToIndexFieldMappingProperty(
            data_source_field_name="dataSourceFieldName",
            index_field_name="indexFieldName",

            # the properties below are optional
            date_field_format="dateFieldFormat"
        )]
    ),
    space_configuration=kendra.CfnDataSource.ConfluenceSpaceConfigurationProperty(
        crawl_archived_spaces=False,
        crawl_personal_spaces=False,
        exclude_spaces=["excludeSpaces"],
        include_spaces=["includeSpaces"],
        space_field_mappings=[kendra.CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty(
            data_source_field_name="dataSourceFieldName",
            index_field_name="indexFieldName",

            # the properties below are optional
            date_field_format="dateFieldFormat"
        )]
    ),
    vpc_configuration=kendra.CfnDataSource.DataSourceVpcConfigurationProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kendra.*;

ConfluenceConfigurationProperty confluenceConfigurationProperty = ConfluenceConfigurationProperty.builder()
        .secretArn("secretArn")
        .serverUrl("serverUrl")
        .version("version")

        // the properties below are optional
        .attachmentConfiguration(ConfluenceAttachmentConfigurationProperty.builder()
                .attachmentFieldMappings(List.of(ConfluenceAttachmentToIndexFieldMappingProperty.builder()
                        .dataSourceFieldName("dataSourceFieldName")
                        .indexFieldName("indexFieldName")

                        // the properties below are optional
                        .dateFieldFormat("dateFieldFormat")
                        .build()))
                .crawlAttachments(false)
                .build())
        .blogConfiguration(ConfluenceBlogConfigurationProperty.builder()
                .blogFieldMappings(List.of(ConfluenceBlogToIndexFieldMappingProperty.builder()
                        .dataSourceFieldName("dataSourceFieldName")
                        .indexFieldName("indexFieldName")

                        // the properties below are optional
                        .dateFieldFormat("dateFieldFormat")
                        .build()))
                .build())
        .exclusionPatterns(List.of("exclusionPatterns"))
        .inclusionPatterns(List.of("inclusionPatterns"))
        .pageConfiguration(ConfluencePageConfigurationProperty.builder()
                .pageFieldMappings(List.of(ConfluencePageToIndexFieldMappingProperty.builder()
                        .dataSourceFieldName("dataSourceFieldName")
                        .indexFieldName("indexFieldName")

                        // the properties below are optional
                        .dateFieldFormat("dateFieldFormat")
                        .build()))
                .build())
        .spaceConfiguration(ConfluenceSpaceConfigurationProperty.builder()
                .crawlArchivedSpaces(false)
                .crawlPersonalSpaces(false)
                .excludeSpaces(List.of("excludeSpaces"))
                .includeSpaces(List.of("includeSpaces"))
                .spaceFieldMappings(List.of(ConfluenceSpaceToIndexFieldMappingProperty.builder()
                        .dataSourceFieldName("dataSourceFieldName")
                        .indexFieldName("indexFieldName")

                        // the properties below are optional
                        .dateFieldFormat("dateFieldFormat")
                        .build()))
                .build())
        .vpcConfiguration(DataSourceVpcConfigurationProperty.builder()
                .securityGroupIds(List.of("securityGroupIds"))
                .subnetIds(List.of("subnetIds"))
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;

var confluenceConfigurationProperty = new ConfluenceConfigurationProperty {
    SecretArn = "secretArn",
    ServerUrl = "serverUrl",
    Version = "version",

    // the properties below are optional
    AttachmentConfiguration = new ConfluenceAttachmentConfigurationProperty {
        AttachmentFieldMappings = new [] { new ConfluenceAttachmentToIndexFieldMappingProperty {
            DataSourceFieldName = "dataSourceFieldName",
            IndexFieldName = "indexFieldName",

            // the properties below are optional
            DateFieldFormat = "dateFieldFormat"
        } },
        CrawlAttachments = false
    },
    BlogConfiguration = new ConfluenceBlogConfigurationProperty {
        BlogFieldMappings = new [] { new ConfluenceBlogToIndexFieldMappingProperty {
            DataSourceFieldName = "dataSourceFieldName",
            IndexFieldName = "indexFieldName",

            // the properties below are optional
            DateFieldFormat = "dateFieldFormat"
        } }
    },
    ExclusionPatterns = new [] { "exclusionPatterns" },
    InclusionPatterns = new [] { "inclusionPatterns" },
    PageConfiguration = new ConfluencePageConfigurationProperty {
        PageFieldMappings = new [] { new ConfluencePageToIndexFieldMappingProperty {
            DataSourceFieldName = "dataSourceFieldName",
            IndexFieldName = "indexFieldName",

            // the properties below are optional
            DateFieldFormat = "dateFieldFormat"
        } }
    },
    SpaceConfiguration = new ConfluenceSpaceConfigurationProperty {
        CrawlArchivedSpaces = false,
        CrawlPersonalSpaces = false,
        ExcludeSpaces = new [] { "excludeSpaces" },
        IncludeSpaces = new [] { "includeSpaces" },
        SpaceFieldMappings = new [] { new ConfluenceSpaceToIndexFieldMappingProperty {
            DataSourceFieldName = "dataSourceFieldName",
            IndexFieldName = "indexFieldName",

            // the properties below are optional
            DateFieldFormat = "dateFieldFormat"
        } }
    },
    VpcConfiguration = new DataSourceVpcConfigurationProperty {
        SecurityGroupIds = new [] { "securityGroupIds" },
        SubnetIds = new [] { "subnetIds" }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

confluenceConfigurationProperty := &ConfluenceConfigurationProperty{
	SecretArn: jsii.String("secretArn"),
	ServerUrl: jsii.String("serverUrl"),
	Version: jsii.String("version"),

	// the properties below are optional
	AttachmentConfiguration: &ConfluenceAttachmentConfigurationProperty{
		AttachmentFieldMappings: []interface{}{
			&ConfluenceAttachmentToIndexFieldMappingProperty{
				DataSourceFieldName: jsii.String("dataSourceFieldName"),
				IndexFieldName: jsii.String("indexFieldName"),

				// the properties below are optional
				DateFieldFormat: jsii.String("dateFieldFormat"),
			},
		},
		CrawlAttachments: jsii.Boolean(false),
	},
	BlogConfiguration: &ConfluenceBlogConfigurationProperty{
		BlogFieldMappings: []interface{}{
			&ConfluenceBlogToIndexFieldMappingProperty{
				DataSourceFieldName: jsii.String("dataSourceFieldName"),
				IndexFieldName: jsii.String("indexFieldName"),

				// the properties below are optional
				DateFieldFormat: jsii.String("dateFieldFormat"),
			},
		},
	},
	ExclusionPatterns: []*string{
		jsii.String("exclusionPatterns"),
	},
	InclusionPatterns: []*string{
		jsii.String("inclusionPatterns"),
	},
	PageConfiguration: &ConfluencePageConfigurationProperty{
		PageFieldMappings: []interface{}{
			&ConfluencePageToIndexFieldMappingProperty{
				DataSourceFieldName: jsii.String("dataSourceFieldName"),
				IndexFieldName: jsii.String("indexFieldName"),

				// the properties below are optional
				DateFieldFormat: jsii.String("dateFieldFormat"),
			},
		},
	},
	SpaceConfiguration: &ConfluenceSpaceConfigurationProperty{
		CrawlArchivedSpaces: jsii.Boolean(false),
		CrawlPersonalSpaces: jsii.Boolean(false),
		ExcludeSpaces: []*string{
			jsii.String("excludeSpaces"),
		},
		IncludeSpaces: []*string{
			jsii.String("includeSpaces"),
		},
		SpaceFieldMappings: []interface{}{
			&ConfluenceSpaceToIndexFieldMappingProperty{
				DataSourceFieldName: jsii.String("dataSourceFieldName"),
				IndexFieldName: jsii.String("indexFieldName"),

				// the properties below are optional
				DateFieldFormat: jsii.String("dateFieldFormat"),
			},
		},
	},
	VpcConfiguration: &DataSourceVpcConfigurationProperty{
		SecurityGroupIds: []*string{
			jsii.String("securityGroupIds"),
		},
		SubnetIds: []*string{
			jsii.String("subnetIds"),
		},
	},
}

Properties ​

attachmentConfigurationoptionalIResolvable | CfnDataSource.ConfluenceAttachmentConfigurationPropertyattachment_configurationoptionaltyping.Union[IResolvable, ConfluenceAttachmentConfigurationProperty]attachmentConfigurationoptionalIResolvableAttachmentConfigurationoptionalIResolvableAttachmentConfigurationoptionalinterface{} #
Configuration information for indexing attachments to Confluence blogs and pages.
blogConfigurationoptionalIResolvable | CfnDataSource.ConfluenceBlogConfigurationPropertyblog_configurationoptionaltyping.Union[IResolvable, ConfluenceBlogConfigurationProperty]blogConfigurationoptionalIResolvableBlogConfigurationoptionalIResolvableBlogConfigurationoptionalinterface{} #
Configuration information for indexing Confluence blogs.
exclusionPatternsoptionalstring[]exclusion_patternsoptionaltyping.List[str]exclusionPatternsoptionalList<String>ExclusionPatternsoptionalstring[]ExclusionPatternsoptional*[]*string #
A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence.
notes

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.

inclusionPatternsoptionalstring[]inclusion_patternsoptionaltyping.List[str]inclusionPatternsoptionalList<String>InclusionPatternsoptionalstring[]InclusionPatternsoptional*[]*string #
A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence.
notes

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.

pageConfigurationoptionalIResolvable | CfnDataSource.ConfluencePageConfigurationPropertypage_configurationoptionaltyping.Union[IResolvable, ConfluencePageConfigurationProperty]pageConfigurationoptionalIResolvablePageConfigurationoptionalIResolvablePageConfigurationoptionalinterface{} #
Configuration information for indexing Confluence pages.
secretArnstringsecret_arnstrsecretArnStringSecretArnstringSecretArn*string required #
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.
notes

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 .

serverUrlstringserver_urlstrserverUrlStringServerUrlstringServerUrl*string required #
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/ .

spaceConfigurationoptionalIResolvable | CfnDataSource.ConfluenceSpaceConfigurationPropertyspace_configurationoptionaltyping.Union[IResolvable, ConfluenceSpaceConfigurationProperty]spaceConfigurationoptionalIResolvableSpaceConfigurationoptionalIResolvableSpaceConfigurationoptionalinterface{} #
Configuration information for indexing Confluence spaces.
versionstringversionstrversionStringVersionstringVersion*string required #
The version or the type of Confluence installation to connect to.
vpcConfigurationoptionalIResolvable | CfnDataSource.DataSourceVpcConfigurationPropertyvpc_configurationoptionaltyping.Union[IResolvable, DataSourceVpcConfigurationProperty]vpcConfigurationoptionalIResolvableVpcConfigurationoptionalIResolvableVpcConfigurationoptionalinterface{} #
Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence.

For more information, see Configuring a VPC .