Interface CfnFlow.ISalesforceDestinationPropertiesProperty
The properties that are applied when Salesforce is being used as a destination.
Namespace: Amazon.CDK.AWS.AppFlow
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ISalesforceDestinationPropertiesProperty
Syntax (vb)
Public Interface ISalesforceDestinationPropertiesProperty
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 salesforceDestinationPropertiesProperty = new SalesforceDestinationPropertiesProperty {
Object = "object",
// the properties below are optional
DataTransferApi = "dataTransferApi",
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
},
IdFieldNames = new [] { "idFieldNames" },
WriteOperationType = "writeOperationType"
};
Synopsis
Properties
DataTransferApi | Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce. |
ErrorHandlingConfig | The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. |
IdFieldNames | The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete. |
Object | The object specified in the Salesforce flow destination. |
WriteOperationType | This specifies the type of write operation to be performed in Salesforce. |
Properties
DataTransferApi
Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to 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 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 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.
ErrorHandlingConfig
The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination.
virtual object ErrorHandlingConfig { get; }
Property Value
System.Object
Remarks
For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig
is a part of the destination connector details.
IdFieldNames
The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.
virtual string[] IdFieldNames { get; }
Property Value
System.String[]
Remarks
Object
The object specified in the Salesforce flow destination.
string Object { get; }
Property Value
System.String
Remarks
WriteOperationType
This specifies the type of write operation to be performed in Salesforce.
virtual string WriteOperationType { get; }
Property Value
System.String
Remarks
When the value is UPSERT
, then idFieldNames
is required.