public static interface CfnFlow.SalesforceDestinationPropertiesProperty
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.appflow.*; SalesforceDestinationPropertiesProperty salesforceDestinationPropertiesProperty = SalesforceDestinationPropertiesProperty.builder() .object("object") // the properties below are optional .dataTransferApi("dataTransferApi") .errorHandlingConfig(ErrorHandlingConfigProperty.builder() .bucketName("bucketName") .bucketPrefix("bucketPrefix") .failOnFirstError(false) .build()) .idFieldNames(List.of("idFieldNames")) .writeOperationType("writeOperationType") .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnFlow.SalesforceDestinationPropertiesProperty.Builder
A builder for
CfnFlow.SalesforceDestinationPropertiesProperty |
static class |
CfnFlow.SalesforceDestinationPropertiesProperty.Jsii$Proxy
An implementation for
CfnFlow.SalesforceDestinationPropertiesProperty |
Modifier and Type | Method and Description |
---|---|
static CfnFlow.SalesforceDestinationPropertiesProperty.Builder |
builder() |
default java.lang.String |
getDataTransferApi()
Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.
|
default java.lang.Object |
getErrorHandlingConfig()
The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination.
|
default java.util.List<java.lang.String> |
getIdFieldNames()
The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.
|
java.lang.String |
getObject()
The object specified in the Salesforce flow destination.
|
default java.lang.String |
getWriteOperationType()
This specifies the type of write operation to be performed in Salesforce.
|
java.lang.String getObject()
default java.lang.String getDataTransferApi()
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.
default java.lang.Object getErrorHandlingConfig()
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.
default java.util.List<java.lang.String> getIdFieldNames()
default java.lang.String getWriteOperationType()
When the value is UPSERT
, then idFieldNames
is required.
static CfnFlow.SalesforceDestinationPropertiesProperty.Builder builder()