software.amazon.awscdk.services.kendra

Interface CfnDataSource.SalesforceConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.SalesforceConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(value=Stable)
public static interface CfnDataSource.SalesforceConfigurationProperty
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.*;
 SalesforceConfigurationProperty salesforceConfigurationProperty = SalesforceConfigurationProperty.builder()
         .secretArn("secretArn")
         .serverUrl("serverUrl")
         // the properties below are optional
         .chatterFeedConfiguration(SalesforceChatterFeedConfigurationProperty.builder()
                 .documentDataFieldName("documentDataFieldName")
                 // the properties below are optional
                 .documentTitleFieldName("documentTitleFieldName")
                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                         .dataSourceFieldName("dataSourceFieldName")
                         .indexFieldName("indexFieldName")
                         // the properties below are optional
                         .dateFieldFormat("dateFieldFormat")
                         .build()))
                 .includeFilterTypes(List.of("includeFilterTypes"))
                 .build())
         .crawlAttachments(false)
         .excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
         .includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
         .knowledgeArticleConfiguration(SalesforceKnowledgeArticleConfigurationProperty.builder()
                 .includedStates(List.of("includedStates"))
                 // the properties below are optional
                 .customKnowledgeArticleTypeConfigurations(List.of(SalesforceCustomKnowledgeArticleTypeConfigurationProperty.builder()
                         .documentDataFieldName("documentDataFieldName")
                         .name("name")
                         // the properties below are optional
                         .documentTitleFieldName("documentTitleFieldName")
                         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                                 .dataSourceFieldName("dataSourceFieldName")
                                 .indexFieldName("indexFieldName")
                                 // the properties below are optional
                                 .dateFieldFormat("dateFieldFormat")
                                 .build()))
                         .build()))
                 .standardKnowledgeArticleTypeConfiguration(SalesforceStandardKnowledgeArticleTypeConfigurationProperty.builder()
                         .documentDataFieldName("documentDataFieldName")
                         // the properties below are optional
                         .documentTitleFieldName("documentTitleFieldName")
                         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                                 .dataSourceFieldName("dataSourceFieldName")
                                 .indexFieldName("indexFieldName")
                                 // the properties below are optional
                                 .dateFieldFormat("dateFieldFormat")
                                 .build()))
                         .build())
                 .build())
         .standardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfigurationProperty.builder()
                 .documentTitleFieldName("documentTitleFieldName")
                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                         .dataSourceFieldName("dataSourceFieldName")
                         .indexFieldName("indexFieldName")
                         // the properties below are optional
                         .dateFieldFormat("dateFieldFormat")
                         .build()))
                 .build())
         .standardObjectConfigurations(List.of(SalesforceStandardObjectConfigurationProperty.builder()
                 .documentDataFieldName("documentDataFieldName")
                 .name("name")
                 // the properties below are optional
                 .documentTitleFieldName("documentTitleFieldName")
                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                         .dataSourceFieldName("dataSourceFieldName")
                         .indexFieldName("indexFieldName")
                         // the properties below are optional
                         .dateFieldFormat("dateFieldFormat")
                         .build()))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.SalesforceConfigurationProperty.Builder	builder()
default Object	getChatterFeedConfiguration() `CfnDataSource.SalesforceConfigurationProperty.ChatterFeedConfiguration`.
default Object	getCrawlAttachments() `CfnDataSource.SalesforceConfigurationProperty.CrawlAttachments`.
default List<String>	getExcludeAttachmentFilePatterns() `CfnDataSource.SalesforceConfigurationProperty.ExcludeAttachmentFilePatterns`.
default List<String>	getIncludeAttachmentFilePatterns() `CfnDataSource.SalesforceConfigurationProperty.IncludeAttachmentFilePatterns`.
default Object	getKnowledgeArticleConfiguration() `CfnDataSource.SalesforceConfigurationProperty.KnowledgeArticleConfiguration`.
String	getSecretArn() `CfnDataSource.SalesforceConfigurationProperty.SecretArn`.
String	getServerUrl() `CfnDataSource.SalesforceConfigurationProperty.ServerUrl`.
default Object	getStandardObjectAttachmentConfiguration() `CfnDataSource.SalesforceConfigurationProperty.StandardObjectAttachmentConfiguration`.
default Object	getStandardObjectConfigurations() `CfnDataSource.SalesforceConfigurationProperty.StandardObjectConfigurations`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getChatterFeedConfiguration

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

`CfnDataSource.SalesforceConfigurationProperty.ChatterFeedConfiguration`.

getCrawlAttachments

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

`CfnDataSource.SalesforceConfigurationProperty.CrawlAttachments`.

getExcludeAttachmentFilePatterns

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

`CfnDataSource.SalesforceConfigurationProperty.ExcludeAttachmentFilePatterns`.

getIncludeAttachmentFilePatterns

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

`CfnDataSource.SalesforceConfigurationProperty.IncludeAttachmentFilePatterns`.

getKnowledgeArticleConfiguration

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

`CfnDataSource.SalesforceConfigurationProperty.KnowledgeArticleConfiguration`.

getSecretArn

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

`CfnDataSource.SalesforceConfigurationProperty.SecretArn`.

getServerUrl

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

`CfnDataSource.SalesforceConfigurationProperty.ServerUrl`.

getStandardObjectAttachmentConfiguration

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

`CfnDataSource.SalesforceConfigurationProperty.StandardObjectAttachmentConfiguration`.

getStandardObjectConfigurations

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

`CfnDataSource.SalesforceConfigurationProperty.StandardObjectConfigurations`.

builder

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

Returns:

a CfnDataSource.SalesforceConfigurationProperty.Builder of CfnDataSource.SalesforceConfigurationProperty