Class CfnDataSourcePropsMixin.SalesforceCustomKnowledgeArticleTypeConfigurationProperty

Provides the configuration information for indexing Salesforce custom articles.

Inheritance

object

CfnDataSourcePropsMixin.SalesforceCustomKnowledgeArticleTypeConfigurationProperty

Implements

CfnDataSourcePropsMixin.ISalesforceCustomKnowledgeArticleTypeConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnDataSourcePropsMixin.SalesforceCustomKnowledgeArticleTypeConfigurationProperty : CfnDataSourcePropsMixin.ISalesforceCustomKnowledgeArticleTypeConfigurationProperty

Syntax (vb)

Public Class CfnDataSourcePropsMixin.SalesforceCustomKnowledgeArticleTypeConfigurationProperty Implements 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

Constructors

SalesforceCustomKnowledgeArticleTypeConfigurationProperty()

Provides the configuration information for indexing Salesforce custom articles.

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.

Constructors

SalesforceCustomKnowledgeArticleTypeConfigurationProperty()

Provides the configuration information for indexing Salesforce custom articles.

public SalesforceCustomKnowledgeArticleTypeConfigurationProperty()

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"
             };

Properties

DocumentDataFieldName

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

public string? DocumentDataFieldName { get; set; }

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.

public string? DocumentTitleFieldName { get; set; }

Property Value

string

Remarks

FieldMappings

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

public object? FieldMappings { get; set; }

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.

public string? Name { get; set; }

Property Value

string

Remarks

Implements

CfnDataSourcePropsMixin.ISalesforceCustomKnowledgeArticleTypeConfigurationProperty