Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.SalesforceStandardObjectConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.SalesforceStandardObjectConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.SalesforceStandardObjectConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Specifies configuration information for indexing a single standard object.

Example:

 // 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.*;
 SalesforceStandardObjectConfigurationProperty salesforceStandardObjectConfigurationProperty = SalesforceStandardObjectConfigurationProperty.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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSource.SalesforceStandardObjectConfigurationProperty.Builder	A builder for CfnDataSource.SalesforceStandardObjectConfigurationProperty
static final class	CfnDataSource.SalesforceStandardObjectConfigurationProperty.Jsii$Proxy	An implementation for CfnDataSource.SalesforceStandardObjectConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.SalesforceStandardObjectConfigurationProperty.Builder	builder()
String	getDocumentDataFieldName()	The name of the field in the standard object table that contains the document contents.
default String	getDocumentTitleFieldName()	The name of the field in the standard object table that contains the document title.
default Object	getFieldMappings()	Maps attributes or field names of the standard object to Amazon Kendra index field names.
String	getName()	The name of the standard object.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDocumentDataFieldName

@Stability(Stable)
@NotNull
String getDocumentDataFieldName()

The name of the field in the standard object table that contains the document contents.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the standard object.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectconfiguration.html#cfn-kendra-datasource-salesforcestandardobjectconfiguration-name

getDocumentTitleFieldName

@Stability(Stable)
@Nullable
default String getDocumentTitleFieldName()

The name of the field in the standard object table that contains the document title.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectconfiguration.html#cfn-kendra-datasource-salesforcestandardobjectconfiguration-documenttitlefieldname

getFieldMappings

@Stability(Stable)
@Nullable
default Object getFieldMappings()

Maps attributes or field names of the standard object 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 . The Salesforce data source field names must exist in your Salesforce custom metadata.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectconfiguration.html#cfn-kendra-datasource-salesforcestandardobjectconfiguration-fieldmappings

builder

@Stability(Stable)
static CfnDataSource.SalesforceStandardObjectConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.SalesforceStandardObjectConfigurationProperty.Builder of CfnDataSource.SalesforceStandardObjectConfigurationProperty