software.amazon.awscdk.services.appflow

Interface CfnFlow.SalesforceDestinationPropertiesProperty

All Known Implementing Classes:

CfnFlow.SalesforceDestinationPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnFlow

public static interface CfnFlow.SalesforceDestinationPropertiesProperty

The properties that are applied when Salesforce is being used as a destination.

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnFlow.SalesforceDestinationPropertiesProperty.Builder	builder()
default java.lang.String	getDataTransferApi() `CfnFlow.SalesforceDestinationPropertiesProperty.DataTransferApi`.
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.

Method Detail

getObject

java.lang.String getObject()

The object specified in the Salesforce flow destination.

getDataTransferApi

default java.lang.String getDataTransferApi()

`CfnFlow.SalesforceDestinationPropertiesProperty.DataTransferApi`.

getErrorHandlingConfig

default java.lang.Object getErrorHandlingConfig()

The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination.

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.

getIdFieldNames

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.

getWriteOperationType

default java.lang.String getWriteOperationType()

This specifies the type of write operation to be performed in Salesforce.

When the value is UPSERT , then idFieldNames is required.

builder

static CfnFlow.SalesforceDestinationPropertiesProperty.Builder builder()

Returns:

a CfnFlow.SalesforceDestinationPropertiesProperty.Builder of CfnFlow.SalesforceDestinationPropertiesProperty