Interface CfnFlow.ZendeskDestinationPropertiesProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnFlow.ZendeskDestinationPropertiesProperty.Jsii$Proxy
Enclosing class:
CfnFlow

@Stability(Stable) public static interface CfnFlow.ZendeskDestinationPropertiesProperty extends software.amazon.jsii.JsiiSerializable
The properties that are applied when Zendesk is 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.*;
 ZendeskDestinationPropertiesProperty zendeskDestinationPropertiesProperty = ZendeskDestinationPropertiesProperty.builder()
         .object("object")
         // the properties below are optional
         .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                 .bucketName("bucketName")
                 .bucketPrefix("bucketPrefix")
                 .failOnFirstError(false)
                 .build())
         .idFieldNames(List.of("idFieldNames"))
         .writeOperationType("writeOperationType")
         .build();
 
  • Method Details

    • getObject

      @Stability(Stable) @NotNull String getObject()
      The object specified in the Zendesk 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.
    • 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.ZendeskDestinationPropertiesProperty.Builder builder()
      Returns:
      a CfnFlow.ZendeskDestinationPropertiesProperty.Builder of CfnFlow.ZendeskDestinationPropertiesProperty