# SalesforceCustomKnowledgeArticleTypeConfigurationProperty

Provides the configuration information for indexing Salesforce custom articles.

- Source: Generated at build time
- Type last changed: v2.93.0 · 23 Aug 2023

## Example

TypeScript:

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const salesforceCustomKnowledgeArticleTypeConfigurationProperty: kendra.CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty = {
  documentDataFieldName: 'documentDataFieldName',
  name: 'name',

  // the properties below are optional
  documentTitleFieldName: 'documentTitleFieldName',
  fieldMappings: [{
    dataSourceFieldName: 'dataSourceFieldName',
    indexFieldName: 'indexFieldName',

    // the properties below are optional
    dateFieldFormat: 'dateFieldFormat',
  }],
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra

salesforce_custom_knowledge_article_type_configuration_property = kendra.CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty(
    document_data_field_name="documentDataFieldName",
    name="name",

    # the properties below are optional
    document_title_field_name="documentTitleFieldName",
    field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
        data_source_field_name="dataSourceFieldName",
        index_field_name="indexFieldName",

        # the properties below are optional
        date_field_format="dateFieldFormat"
    )]
)
```

Java:

```java
// 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.*;

SalesforceCustomKnowledgeArticleTypeConfigurationProperty salesforceCustomKnowledgeArticleTypeConfigurationProperty = 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();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 salesforceCustomKnowledgeArticleTypeConfigurationProperty = 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"
    } }
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

salesforceCustomKnowledgeArticleTypeConfigurationProperty := &SalesforceCustomKnowledgeArticleTypeConfigurationProperty{
	DocumentDataFieldName: jsii.String("documentDataFieldName"),
	Name: jsii.String("name"),

	// the properties below are optional
	DocumentTitleFieldName: jsii.String("documentTitleFieldName"),
	FieldMappings: []interface{}{
		&DataSourceToIndexFieldMappingProperty{
			DataSourceFieldName: jsii.String("dataSourceFieldName"),
			IndexFieldName: jsii.String("indexFieldName"),

			// the properties below are optional
			DateFieldFormat: jsii.String("dateFieldFormat"),
		},
	},
}
```

## Properties

- `documentDataFieldName`: string (required) — The name of the field in the custom knowledge article that contains the document data to index.

- `documentTitleFieldName`: string — The name of the field in the custom knowledge article that contains the document title.

- `fieldMappings`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDataSource.DataSourceToIndexFieldMappingProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty.html)[] — Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names.

  To create custom fields, use the `UpdateIndex` API before you map to Salesforce fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Salesforce data source field names must exist in your Salesforce custom metadata.

- `name`: string (required) — The name of the configuration.
