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

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() `CfnDataSource.ConfluenceConfigurationProperty.AttachmentConfiguration`.
default Object	getBlogConfiguration() `CfnDataSource.ConfluenceConfigurationProperty.BlogConfiguration`.
default List<String>	getExclusionPatterns() `CfnDataSource.ConfluenceConfigurationProperty.ExclusionPatterns`.
default List<String>	getInclusionPatterns() `CfnDataSource.ConfluenceConfigurationProperty.InclusionPatterns`.
default Object	getPageConfiguration() `CfnDataSource.ConfluenceConfigurationProperty.PageConfiguration`.
String	getSecretArn() `CfnDataSource.ConfluenceConfigurationProperty.SecretArn`.
String	getServerUrl() `CfnDataSource.ConfluenceConfigurationProperty.ServerUrl`.
default Object	getSpaceConfiguration() `CfnDataSource.ConfluenceConfigurationProperty.SpaceConfiguration`.
String	getVersion() `CfnDataSource.ConfluenceConfigurationProperty.Version`.
default Object	getVpcConfiguration() `CfnDataSource.ConfluenceConfigurationProperty.VpcConfiguration`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAttachmentConfiguration

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

`CfnDataSource.ConfluenceConfigurationProperty.AttachmentConfiguration`.

getBlogConfiguration

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

`CfnDataSource.ConfluenceConfigurationProperty.BlogConfiguration`.

getExclusionPatterns

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

`CfnDataSource.ConfluenceConfigurationProperty.ExclusionPatterns`.

getInclusionPatterns

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

`CfnDataSource.ConfluenceConfigurationProperty.InclusionPatterns`.

getPageConfiguration

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

`CfnDataSource.ConfluenceConfigurationProperty.PageConfiguration`.

getSecretArn

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

`CfnDataSource.ConfluenceConfigurationProperty.SecretArn`.

getServerUrl

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

`CfnDataSource.ConfluenceConfigurationProperty.ServerUrl`.

getSpaceConfiguration

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

`CfnDataSource.ConfluenceConfigurationProperty.SpaceConfiguration`.

getVersion

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

`CfnDataSource.ConfluenceConfigurationProperty.Version`.

getVpcConfiguration

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

`CfnDataSource.ConfluenceConfigurationProperty.VpcConfiguration`.

builder

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

Returns:

a CfnDataSource.ConfluenceConfigurationProperty.Builder of CfnDataSource.ConfluenceConfigurationProperty