Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.ConfluenceConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.ConfluenceConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.ConfluenceConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSource.ConfluenceConfigurationProperty.Builder	A builder for CfnDataSource.ConfluenceConfigurationProperty
static final class	CfnDataSource.ConfluenceConfigurationProperty.Jsii$Proxy	An implementation for CfnDataSource.ConfluenceConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.ConfluenceConfigurationProperty.Builder	builder()
default Object	getAttachmentConfiguration()	Configuration information for indexing attachments to Confluence blogs and pages.
default Object	getBlogConfiguration()	Configuration information for indexing Confluence blogs.
default List<String>	getExclusionPatterns()	A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence.
default List<String>	getInclusionPatterns()	A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence.
default Object	getPageConfiguration()	Configuration information for indexing Confluence pages.
String	getSecretArn()	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.
String	getServerUrl()	The URL of your Confluence instance.
default Object	getSpaceConfiguration()	Configuration information for indexing Confluence spaces.
String	getVersion()	The version or the type of Confluence installation to connect to.
default Object	getVpcConfiguration()	Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSecretArn

@Stability(Stable)
@NotNull
String getSecretArn()

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 .

getServerUrl

@Stability(Stable)
@NotNull
String getServerUrl()

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

getVersion

@Stability(Stable)
@NotNull
String getVersion()

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

getAttachmentConfiguration

@Stability(Stable)
@Nullable
default Object getAttachmentConfiguration()

Configuration information for indexing attachments to Confluence blogs and pages.

getBlogConfiguration

@Stability(Stable)
@Nullable
default Object getBlogConfiguration()

Configuration information for indexing Confluence blogs.

getExclusionPatterns

@Stability(Stable)
@Nullable
default List<String> getExclusionPatterns()

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.

getInclusionPatterns

@Stability(Stable)
@Nullable
default List<String> getInclusionPatterns()

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.

getPageConfiguration

@Stability(Stable)
@Nullable
default Object getPageConfiguration()

Configuration information for indexing Confluence pages.

getSpaceConfiguration

@Stability(Stable)
@Nullable
default Object getSpaceConfiguration()

Configuration information for indexing Confluence spaces.

getVpcConfiguration

@Stability(Stable)
@Nullable
default Object getVpcConfiguration()

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

For more information, see Configuring a VPC .

builder

@Stability(Stable)
static CfnDataSource.ConfluenceConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.ConfluenceConfigurationProperty.Builder of CfnDataSource.ConfluenceConfigurationProperty