Interface CfnDataSourcePropsMixin.ISalesforceCustomKnowledgeArticleTypeConfigurationProperty

Provides the configuration information for indexing Salesforce custom articles.

Namespace: Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface CfnDataSourcePropsMixin.ISalesforceCustomKnowledgeArticleTypeConfigurationProperty

Syntax (vb)

Public Interface CfnDataSourcePropsMixin.ISalesforceCustomKnowledgeArticleTypeConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration.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.Mixins.Preview.AWS.Kendra.Mixins;

             var salesforceCustomKnowledgeArticleTypeConfigurationProperty = new SalesforceCustomKnowledgeArticleTypeConfigurationProperty {
                 DocumentDataFieldName = "documentDataFieldName",
                 DocumentTitleFieldName = "documentTitleFieldName",
                 FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                     DataSourceFieldName = "dataSourceFieldName",
                     DateFieldFormat = "dateFieldFormat",
                     IndexFieldName = "indexFieldName"
                 } },
                 Name = "name"
             };

Synopsis

Properties

DocumentDataFieldName	The name of the field in the custom knowledge article that contains the document data to index.
DocumentTitleFieldName	The name of the field in the custom knowledge article that contains the document title.
FieldMappings	Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names.
Name	The name of the configuration.

Properties

DocumentDataFieldName

The name of the field in the custom knowledge article that contains the document data to index.

string? DocumentDataFieldName { get; }

Property Value

string

Remarks

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

DocumentTitleFieldName

The name of the field in the custom knowledge article that contains the document title.

string? DocumentTitleFieldName { get; }

Property Value

string

Remarks

FieldMappings

Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names.

object? FieldMappings { get; }

Property Value

object

Remarks

To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.

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

Name

The name of the configuration.

string? Name { get; }

Property Value

string