Interface CfnFlow.ISalesforceSourcePropertiesProperty
The properties that are applied when Salesforce is being used as a source.
Namespace: Amazon.CDK.AWS.AppFlow
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ISalesforceSourcePropertiesProperty
Syntax (vb)
Public Interface ISalesforceSourcePropertiesProperty
Remarks
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.AWS.AppFlow;
var salesforceSourcePropertiesProperty = new SalesforceSourcePropertiesProperty {
Object = "object",
// the properties below are optional
DataTransferApi = "dataTransferApi",
EnableDynamicFieldUpdate = false,
IncludeDeletedRecords = false
};
Synopsis
Properties
DataTransferApi | Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce. |
EnableDynamicFieldUpdate | The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow. |
IncludeDeletedRecords | Indicates whether Amazon AppFlow includes deleted files in the flow run. |
Object | The object specified in the Salesforce flow source. |
Properties
DataTransferApi
Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce.
virtual string DataTransferApi { get; }
Property Value
System.String
Remarks
Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.
By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.
Note that Bulk API 2.0 does not transfer Salesforce compound fields.
EnableDynamicFieldUpdate
The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
virtual object EnableDynamicFieldUpdate { get; }
Property Value
System.Object
Remarks
IncludeDeletedRecords
Indicates whether Amazon AppFlow includes deleted files in the flow run.
virtual object IncludeDeletedRecords { get; }
Property Value
System.Object
Remarks
Object
The object specified in the Salesforce flow source.
string Object { get; }
Property Value
System.String