Package software.amazon.awscdk.services.appflow

Class CfnFlow.SalesforceSourcePropertiesProperty.Builder

java.lang.Object

software.amazon.awscdk.services.appflow.CfnFlow.SalesforceSourcePropertiesProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFlow.SalesforceSourcePropertiesProperty>

Enclosing interface:

CfnFlow.SalesforceSourcePropertiesProperty

@Stability(Stable)
public static final class CfnFlow.SalesforceSourcePropertiesProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnFlow.SalesforceSourcePropertiesProperty>

A builder for CfnFlow.SalesforceSourcePropertiesProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnFlow.SalesforceSourcePropertiesProperty	build()	Builds the configured instance.
CfnFlow.SalesforceSourcePropertiesProperty.Builder	dataTransferApi(String dataTransferApi)	Sets the value of CfnFlow.SalesforceSourcePropertiesProperty.getDataTransferApi()
CfnFlow.SalesforceSourcePropertiesProperty.Builder	enableDynamicFieldUpdate(Boolean enableDynamicFieldUpdate)	Sets the value of CfnFlow.SalesforceSourcePropertiesProperty.getEnableDynamicFieldUpdate()
CfnFlow.SalesforceSourcePropertiesProperty.Builder	enableDynamicFieldUpdate(IResolvable enableDynamicFieldUpdate)	Sets the value of CfnFlow.SalesforceSourcePropertiesProperty.getEnableDynamicFieldUpdate()
CfnFlow.SalesforceSourcePropertiesProperty.Builder	includeDeletedRecords(Boolean includeDeletedRecords)	Sets the value of CfnFlow.SalesforceSourcePropertiesProperty.getIncludeDeletedRecords()
CfnFlow.SalesforceSourcePropertiesProperty.Builder	includeDeletedRecords(IResolvable includeDeletedRecords)	Sets the value of CfnFlow.SalesforceSourcePropertiesProperty.getIncludeDeletedRecords()
CfnFlow.SalesforceSourcePropertiesProperty.Builder	object(String object)	Sets the value of CfnFlow.SalesforceSourcePropertiesProperty.getObject()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

object

@Stability(Stable)
public CfnFlow.SalesforceSourcePropertiesProperty.Builder object(String object)

Sets the value of CfnFlow.SalesforceSourcePropertiesProperty.getObject()

Parameters:

object - The object specified in the Salesforce flow source. This parameter is required.

Returns:

this

dataTransferApi

@Stability(Stable)
public CfnFlow.SalesforceSourcePropertiesProperty.Builder dataTransferApi(String dataTransferApi)

Sets the value of CfnFlow.SalesforceSourcePropertiesProperty.getDataTransferApi()

Parameters:

dataTransferApi - Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce.

• AUTOMATIC - The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.

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.

• BULKV2 - Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.

Note that Bulk API 2.0 does not transfer Salesforce compound fields.

• REST_SYNC - Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error.

Returns:

this

enableDynamicFieldUpdate

@Stability(Stable)
public CfnFlow.SalesforceSourcePropertiesProperty.Builder enableDynamicFieldUpdate(Boolean enableDynamicFieldUpdate)

Sets the value of CfnFlow.SalesforceSourcePropertiesProperty.getEnableDynamicFieldUpdate()

Parameters:

enableDynamicFieldUpdate - The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.

Returns:

this

enableDynamicFieldUpdate

@Stability(Stable)
public CfnFlow.SalesforceSourcePropertiesProperty.Builder enableDynamicFieldUpdate(IResolvable enableDynamicFieldUpdate)

Sets the value of CfnFlow.SalesforceSourcePropertiesProperty.getEnableDynamicFieldUpdate()

Parameters:

enableDynamicFieldUpdate - The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.

Returns:

this

includeDeletedRecords

@Stability(Stable)
public CfnFlow.SalesforceSourcePropertiesProperty.Builder includeDeletedRecords(Boolean includeDeletedRecords)

Sets the value of CfnFlow.SalesforceSourcePropertiesProperty.getIncludeDeletedRecords()

Parameters:

includeDeletedRecords - Indicates whether Amazon AppFlow includes deleted files in the flow run.

Returns:

this

includeDeletedRecords

@Stability(Stable)
public CfnFlow.SalesforceSourcePropertiesProperty.Builder includeDeletedRecords(IResolvable includeDeletedRecords)

Sets the value of CfnFlow.SalesforceSourcePropertiesProperty.getIncludeDeletedRecords()

Parameters:

includeDeletedRecords - Indicates whether Amazon AppFlow includes deleted files in the flow run.

Returns:

this

build

@Stability(Stable)
public CfnFlow.SalesforceSourcePropertiesProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnFlow.SalesforceSourcePropertiesProperty>

Returns:

a new instance of CfnFlow.SalesforceSourcePropertiesProperty

Throws:

NullPointerException - if any required attribute was not provided