Skip to content
v2.278.0

SalesforceKnowledgeArticleConfigurationProperty Struct ​

Provides the configuration information for the knowledge article types that Amazon Kendra indexes.

Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both

Example ​

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 salesforceKnowledgeArticleConfigurationProperty: kendra.CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty = {
  includedStates: ['includedStates'],

  // the properties below are optional
  customKnowledgeArticleTypeConfigurations: [{
    documentDataFieldName: 'documentDataFieldName',
    name: 'name',

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

      // the properties below are optional
      dateFieldFormat: 'dateFieldFormat',
    }],
  }],
  standardKnowledgeArticleTypeConfiguration: {
    documentDataFieldName: 'documentDataFieldName',

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

      // the properties below are optional
      dateFieldFormat: 'dateFieldFormat',
    }],
  },
};
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_knowledge_article_configuration_property = kendra.CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty(
    included_states=["includedStates"],

    # the properties below are optional
    custom_knowledge_article_type_configurations=[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"
        )]
    )],
    standard_knowledge_article_type_configuration=kendra.CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty(
        document_data_field_name="documentDataFieldName",

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

SalesforceKnowledgeArticleConfigurationProperty salesforceKnowledgeArticleConfigurationProperty = 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();
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 salesforceKnowledgeArticleConfigurationProperty = 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"
        } }
    }
};
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"

salesforceKnowledgeArticleConfigurationProperty := &SalesforceKnowledgeArticleConfigurationProperty{
	IncludedStates: []*string{
		jsii.String("includedStates"),
	},

	// the properties below are optional
	CustomKnowledgeArticleTypeConfigurations: []interface{}{
		&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"),
				},
			},
		},
	},
	StandardKnowledgeArticleTypeConfiguration: &SalesforceStandardKnowledgeArticleTypeConfigurationProperty{
		DocumentDataFieldName: jsii.String("documentDataFieldName"),

		// 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 ​

customKnowledgeArticleTypeConfigurationsoptionalIResolvable | IResolvable | CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty[]custom_knowledge_article_type_configurationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SalesforceCustomKnowledgeArticleTypeConfigurationProperty]]]customKnowledgeArticleTypeConfigurationsoptionalIResolvableCustomKnowledgeArticleTypeConfigurationsoptionalIResolvableCustomKnowledgeArticleTypeConfigurationsoptionalinterface{} #
Configuration information for custom Salesforce knowledge articles.
includedStatesstring[]included_statestyping.List[str]includedStatesList<String>IncludedStatesstring[]IncludedStates*[]*string required #
Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.

You must specify at least one state.

standardKnowledgeArticleTypeConfigurationoptionalIResolvable | CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationPropertystandard_knowledge_article_type_configurationoptionaltyping.Union[IResolvable, SalesforceStandardKnowledgeArticleTypeConfigurationProperty]standardKnowledgeArticleTypeConfigurationoptionalIResolvableStandardKnowledgeArticleTypeConfigurationoptionalIResolvableStandardKnowledgeArticleTypeConfigurationoptionalinterface{} #
Configuration information for standard Salesforce knowledge articles.