Package software.amazon.awscdk.services.appflow

Interface CfnFlow.SAPODataDestinationPropertiesProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnFlow.SAPODataDestinationPropertiesProperty.Jsii$Proxy
Enclosing class:
CfnFlow
@Stability(Stable) public static interface CfnFlow.SAPODataDestinationPropertiesProperty extends software.amazon.jsii.JsiiSerializable
The properties that are applied when using SAPOData as a flow 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.*;
 SAPODataDestinationPropertiesProperty sAPODataDestinationPropertiesProperty = SAPODataDestinationPropertiesProperty.builder()
         .objectPath("objectPath")
         // the properties below are optional
         .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                 .bucketName("bucketName")
                 .bucketPrefix("bucketPrefix")
                 .failOnFirstError(false)
                 .build())
         .idFieldNames(List.of("idFieldNames"))
         .successResponseHandlingConfig(SuccessResponseHandlingConfigProperty.builder()
                 .bucketName("bucketName")
                 .bucketPrefix("bucketPrefix")
                 .build())
         .writeOperationType("writeOperationType")
         .build();

  • Method Details

    • getObjectPath

      @Stability(Stable) @NotNull String getObjectPath()
      The object path specified in the SAPOData flow destination.

    • getErrorHandlingConfig

      @Stability(Stable) @Nullable default Object getErrorHandlingConfig()
      The settings that determine how Amazon AppFlow handles an error when placing data in the 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

      @Stability(Stable) @Nullable default List<String> getIdFieldNames()
      A list of field names that can be used as an ID field when performing a write operation.

    • getSuccessResponseHandlingConfig

      @Stability(Stable) @Nullable default Object getSuccessResponseHandlingConfig()
      Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data.

      For example, this setting would determine where to write the response from a destination connector upon a successful insert operation.

    • getWriteOperationType

      @Stability(Stable) @Nullable default String getWriteOperationType()
      The possible write operations in the destination connector.

      When this value is not provided, this defaults to the INSERT operation.

    • builder

      @Stability(Stable) static CfnFlow.SAPODataDestinationPropertiesProperty.Builder builder()
      Returns:
      a CfnFlow.SAPODataDestinationPropertiesProperty.Builder of CfnFlow.SAPODataDestinationPropertiesProperty