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(value=Stable)
public static interface CfnDataSource.ConfluenceConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Provides configuration information for data sources that connect to Confluence.

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 and Description
static class	CfnDataSource.ConfluenceConfigurationProperty.Builder A builder for CfnDataSource.ConfluenceConfigurationProperty
static class	CfnDataSource.ConfluenceConfigurationProperty.Jsii$Proxy An implementation for CfnDataSource.ConfluenceConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.ConfluenceConfigurationProperty.Builder	builder()
default Object	getAttachmentConfiguration() Specifies configuration information for indexing attachments to Confluence blogs and pages.
default Object	getBlogConfiguration() Specifies configuration information for indexing Confluence blogs.
default List<String>	getExclusionPatterns() A list of regular expression patterns that apply to a URL on the Confluence server.
default List<String>	getInclusionPatterns() A list of regular expression patterns that apply to a URL on the Confluence server.
default Object	getPageConfiguration() Specifies configuration information for indexing Confluence pages.
String	getSecretArn() The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server.
String	getServerUrl() The URL of your Confluence instance.
default Object	getSpaceConfiguration() Specifies configuration information for indexing Confluence spaces.
String	getVersion() Specifies the version of the Confluence installation that you are connecting to.
default Object	getVpcConfiguration() Specifies the information for connecting to an Amazon VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSecretArn

@Stability(value=Stable)
 @NotNull
String getSecretArn()

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.

getServerUrl

@Stability(value=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(value=Stable)
 @NotNull
String getVersion()

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

getAttachmentConfiguration

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

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

getBlogConfiguration

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

Specifies configuration information for indexing Confluence blogs.

getExclusionPatterns

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

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.

getInclusionPatterns

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

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.

getPageConfiguration

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

Specifies configuration information for indexing Confluence pages.

getSpaceConfiguration

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

Specifies configuration information for indexing Confluence spaces.

getVpcConfiguration

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

Specifies the information for connecting to an Amazon VPC.

builder

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

Returns:

a CfnDataSource.ConfluenceConfigurationProperty.Builder of CfnDataSource.ConfluenceConfigurationProperty