Package software.amazon.awscdk.cfnpropertymixins.services.kendra

Interface CfnDataSourcePropsMixin.SalesforceStandardObjectConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSourcePropsMixin.SalesforceStandardObjectConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSourcePropsMixin

@Stability(Stable)
public static interface CfnDataSourcePropsMixin.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.cfnpropertymixins.services.kendra.*;
 SalesforceStandardObjectConfigurationProperty salesforceStandardObjectConfigurationProperty = SalesforceStandardObjectConfigurationProperty.builder()
         .documentDataFieldName("documentDataFieldName")
         .documentTitleFieldName("documentTitleFieldName")
         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                 .dataSourceFieldName("dataSourceFieldName")
                 .dateFieldFormat("dateFieldFormat")
                 .indexFieldName("indexFieldName")
                 .build()))
         .name("name")
         .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	CfnDataSourcePropsMixin.SalesforceStandardObjectConfigurationProperty.Builder	A builder for CfnDataSourcePropsMixin.SalesforceStandardObjectConfigurationProperty
static final class	CfnDataSourcePropsMixin.SalesforceStandardObjectConfigurationProperty.Jsii$Proxy	An implementation for CfnDataSourcePropsMixin.SalesforceStandardObjectConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSourcePropsMixin.SalesforceStandardObjectConfigurationProperty.Builder	builder()
default 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.
default String	getName()	The name of the standard object.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDocumentDataFieldName

@Stability(Stable)
@Nullable
default 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

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty>

See Also:

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

getName

@Stability(Stable)
@Nullable
default 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

builder

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

Returns:

a CfnDataSourcePropsMixin.SalesforceStandardObjectConfigurationProperty.Builder of CfnDataSourcePropsMixin.SalesforceStandardObjectConfigurationProperty