Class CfnDataSourcePropsMixin.SalesforceKnowledgeArticleConfigurationProperty

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

Inheritance

object

CfnDataSourcePropsMixin.SalesforceKnowledgeArticleConfigurationProperty

Implements

CfnDataSourcePropsMixin.ISalesforceKnowledgeArticleConfigurationProperty

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.SalesforceKnowledgeArticleConfigurationProperty : CfnDataSourcePropsMixin.ISalesforceKnowledgeArticleConfigurationProperty

Syntax (vb)

Public Class CfnDataSourcePropsMixin.SalesforceKnowledgeArticleConfigurationProperty Implements CfnDataSourcePropsMixin.ISalesforceKnowledgeArticleConfigurationProperty

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-salesforceknowledgearticleconfiguration.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 salesforceKnowledgeArticleConfigurationProperty = 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"
                     } }
                 }
             };

Synopsis

Constructors

SalesforceKnowledgeArticleConfigurationProperty()

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

Properties

CustomKnowledgeArticleTypeConfigurations	Configuration information for custom Salesforce knowledge articles.
IncludedStates	Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.
StandardKnowledgeArticleTypeConfiguration	Configuration information for standard Salesforce knowledge articles.

Constructors

SalesforceKnowledgeArticleConfigurationProperty()

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

public SalesforceKnowledgeArticleConfigurationProperty()

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-salesforceknowledgearticleconfiguration.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 salesforceKnowledgeArticleConfigurationProperty = 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"
                     } }
                 }
             };

Properties

CustomKnowledgeArticleTypeConfigurations

Configuration information for custom Salesforce knowledge articles.

public object? CustomKnowledgeArticleTypeConfigurations { get; set; }

Property Value

object

Remarks

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

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

IncludedStates

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.

public string[]? IncludedStates { get; set; }

Property Value

string[]

Remarks

You must specify at least one state.

StandardKnowledgeArticleTypeConfiguration

Configuration information for standard Salesforce knowledge articles.

public object? StandardKnowledgeArticleTypeConfiguration { get; set; }