Class CfnDataSource.SalesforceConfigurationProperty
Provides the configuration information to connect to Salesforce as your data source.
Inheritance
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SalesforceConfigurationProperty : Object, CfnDataSource.ISalesforceConfigurationProperty
Syntax (vb)
Public Class SalesforceConfigurationProperty
Inherits Object
Implements CfnDataSource.ISalesforceConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// 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 salesforceConfigurationProperty = new SalesforceConfigurationProperty {
SecretArn = "secretArn",
ServerUrl = "serverUrl",
// the properties below are optional
ChatterFeedConfiguration = new SalesforceChatterFeedConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
// the properties below are optional
DocumentTitleFieldName = "documentTitleFieldName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
IncludeFilterTypes = new [] { "includeFilterTypes" }
},
CrawlAttachments = false,
ExcludeAttachmentFilePatterns = new [] { "excludeAttachmentFilePatterns" },
IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" },
KnowledgeArticleConfiguration = new SalesforceKnowledgeArticleConfigurationProperty {
IncludedStates = new [] { "includedStates" },
// the properties below are optional
CustomKnowledgeArticleTypeConfigurations = new [] { new SalesforceCustomKnowledgeArticleTypeConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
Name = "name",
// the properties below are optional
DocumentTitleFieldName = "documentTitleFieldName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
} },
StandardKnowledgeArticleTypeConfiguration = new SalesforceStandardKnowledgeArticleTypeConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
// the properties below are optional
DocumentTitleFieldName = "documentTitleFieldName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
}
},
StandardObjectAttachmentConfiguration = new SalesforceStandardObjectAttachmentConfigurationProperty {
DocumentTitleFieldName = "documentTitleFieldName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
},
StandardObjectConfigurations = new [] { new SalesforceStandardObjectConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
Name = "name",
// the properties below are optional
DocumentTitleFieldName = "documentTitleFieldName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
} }
};
Synopsis
Constructors
SalesforceConfigurationProperty() |
Properties
ChatterFeedConfiguration | Configuration information for Salesforce chatter feeds. |
CrawlAttachments | Indicates whether Amazon Kendra should index attachments to Salesforce objects. |
ExcludeAttachmentFilePatterns | A list of regular expression patterns to exclude certain documents in your Salesforce. |
IncludeAttachmentFilePatterns | A list of regular expression patterns to include certain documents in your Salesforce. |
KnowledgeArticleConfiguration | Configuration information for the knowledge article types that Amazon Kendra indexes. |
SecretArn | The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. |
ServerUrl | The instance URL for the Salesforce site that you want to index. |
StandardObjectAttachmentConfiguration | Configuration information for processing attachments to Salesforce standard objects. |
StandardObjectConfigurations | Configuration of the Salesforce standard objects that Amazon Kendra indexes. |
Constructors
SalesforceConfigurationProperty()
public SalesforceConfigurationProperty()
Properties
ChatterFeedConfiguration
Configuration information for Salesforce chatter feeds.
public object ChatterFeedConfiguration { get; set; }
Property Value
System.Object
Remarks
CrawlAttachments
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
public object CrawlAttachments { get; set; }
Property Value
System.Object
Remarks
ExcludeAttachmentFilePatterns
A list of regular expression patterns to exclude certain documents in your Salesforce.
public string[] ExcludeAttachmentFilePatterns { get; set; }
Property Value
System.String[]
Remarks
Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
IncludeAttachmentFilePatterns
A list of regular expression patterns to include certain documents in your Salesforce.
public string[] IncludeAttachmentFilePatterns { get; set; }
Property Value
System.String[]
Remarks
Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
KnowledgeArticleConfiguration
Configuration information for the knowledge article types that Amazon Kendra indexes.
public object KnowledgeArticleConfiguration { get; set; }
Property Value
System.Object
Remarks
Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.
SecretArn
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance.
public string SecretArn { get; set; }
Property Value
System.String
Remarks
The secret must contain a JSON structure with the following keys:
ServerUrl
The instance URL for the Salesforce site that you want to index.
public string ServerUrl { get; set; }
Property Value
System.String
Remarks
StandardObjectAttachmentConfiguration
Configuration information for processing attachments to Salesforce standard objects.
public object StandardObjectAttachmentConfiguration { get; set; }
Property Value
System.Object
Remarks
StandardObjectConfigurations
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
public object StandardObjectConfigurations { get; set; }
Property Value
System.Object