Interface CfnDataSourcePropsMixin.ISalesforceConfigurationProperty

Provides the configuration information to connect to Salesforce as your data source.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Kendra

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface CfnDataSourcePropsMixin.ISalesforceConfigurationProperty

Syntax (vb)

Public Interface CfnDataSourcePropsMixin.ISalesforceConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html

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.CfnPropertyMixins.AWS.Kendra;

             var salesforceConfigurationProperty = new SalesforceConfigurationProperty {
                 ChatterFeedConfiguration = new SalesforceChatterFeedConfigurationProperty {
                     DocumentDataFieldName = "documentDataFieldName",
                     DocumentTitleFieldName = "documentTitleFieldName",
                     FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                         DataSourceFieldName = "dataSourceFieldName",
                         DateFieldFormat = "dateFieldFormat",
                         IndexFieldName = "indexFieldName"
                     } },
                     IncludeFilterTypes = new [] { "includeFilterTypes" }
                 },
                 CrawlAttachments = false,
                 ExcludeAttachmentFilePatterns = new [] { "excludeAttachmentFilePatterns" },
                 IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" },
                 KnowledgeArticleConfiguration = new SalesforceKnowledgeArticleConfigurationProperty {
                     CustomKnowledgeArticleTypeConfigurations = new [] { new SalesforceCustomKnowledgeArticleTypeConfigurationProperty {
                         DocumentDataFieldName = "documentDataFieldName",
                         DocumentTitleFieldName = "documentTitleFieldName",
                         FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                             DataSourceFieldName = "dataSourceFieldName",
                             DateFieldFormat = "dateFieldFormat",
                             IndexFieldName = "indexFieldName"
                         } },
                         Name = "name"
                     } },
                     IncludedStates = new [] { "includedStates" },
                     StandardKnowledgeArticleTypeConfiguration = new SalesforceStandardKnowledgeArticleTypeConfigurationProperty {
                         DocumentDataFieldName = "documentDataFieldName",
                         DocumentTitleFieldName = "documentTitleFieldName",
                         FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                             DataSourceFieldName = "dataSourceFieldName",
                             DateFieldFormat = "dateFieldFormat",
                             IndexFieldName = "indexFieldName"
                         } }
                     }
                 },
                 SecretArn = "secretArn",
                 ServerUrl = "serverUrl",
                 StandardObjectAttachmentConfiguration = new SalesforceStandardObjectAttachmentConfigurationProperty {
                     DocumentTitleFieldName = "documentTitleFieldName",
                     FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                         DataSourceFieldName = "dataSourceFieldName",
                         DateFieldFormat = "dateFieldFormat",
                         IndexFieldName = "indexFieldName"
                     } }
                 },
                 StandardObjectConfigurations = new [] { new SalesforceStandardObjectConfigurationProperty {
                     DocumentDataFieldName = "documentDataFieldName",
                     DocumentTitleFieldName = "documentTitleFieldName",
                     FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                         DataSourceFieldName = "dataSourceFieldName",
                         DateFieldFormat = "dateFieldFormat",
                         IndexFieldName = "indexFieldName"
                     } },
                     Name = "name"
                 } }
             };

Synopsis

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.

Properties

ChatterFeedConfiguration

Configuration information for Salesforce chatter feeds.

object? ChatterFeedConfiguration { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-chatterfeedconfiguration

Type union: either IResolvable or CfnDataSourcePropsMixin.ISalesforceChatterFeedConfigurationProperty

CrawlAttachments

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

object? CrawlAttachments { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-crawlattachments

Type union: either bool or IResolvable

ExcludeAttachmentFilePatterns

A list of regular expression patterns to exclude certain documents in your Salesforce.

string[]? ExcludeAttachmentFilePatterns { get; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-excludeattachmentfilepatterns

IncludeAttachmentFilePatterns

A list of regular expression patterns to include certain documents in your Salesforce.

string[]? IncludeAttachmentFilePatterns { get; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-includeattachmentfilepatterns

KnowledgeArticleConfiguration

Configuration information for the knowledge article types that Amazon Kendra indexes.

object? KnowledgeArticleConfiguration { get; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-knowledgearticleconfiguration

Type union: either IResolvable or CfnDataSourcePropsMixin.ISalesforceKnowledgeArticleConfigurationProperty

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.

string? SecretArn { get; }

Property Value

string

Remarks

The secret must contain a JSON structure with the following keys:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-secretarn

ServerUrl

The instance URL for the Salesforce site that you want to index.

string? ServerUrl { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-serverurl

StandardObjectAttachmentConfiguration

Configuration information for processing attachments to Salesforce standard objects.

object? StandardObjectAttachmentConfiguration { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-standardobjectattachmentconfiguration

Type union: either IResolvable or CfnDataSourcePropsMixin.ISalesforceStandardObjectAttachmentConfigurationProperty

StandardObjectConfigurations

Configuration of the Salesforce standard objects that Amazon Kendra indexes.

object? StandardObjectConfigurations { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-standardobjectconfigurations

Type union: either IResolvable or (either IResolvable or CfnDataSourcePropsMixin.ISalesforceStandardObjectConfigurationProperty)[]