software.amazon.awscdk.services.appflow

Interface CfnFlow.ZendeskDestinationPropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.ZendeskDestinationPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnFlow

@Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnFlow.ZendeskDestinationPropertiesProperty.Builder A builder for CfnFlow.ZendeskDestinationPropertiesProperty
static class	CfnFlow.ZendeskDestinationPropertiesProperty.Jsii$Proxy An implementation for CfnFlow.ZendeskDestinationPropertiesProperty

Method Summary

Modifier and Type	Method and Description
static CfnFlow.ZendeskDestinationPropertiesProperty.Builder	builder()
default Object	getErrorHandlingConfig() The settings that determine how Amazon AppFlow handles an error when placing data in the destination.
default List<String>	getIdFieldNames() A list of field names that can be used as an ID field when performing a write operation.
String	getObject() The object specified in the Zendesk flow destination.
default String	getWriteOperationType() The possible write operations in the destination connector.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getObject

@Stability(value=Stable)
 @NotNull
String getObject()

The object specified in the Zendesk flow destination.

getErrorHandlingConfig

@Stability(value=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(value=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(value=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(value=Stable)
static CfnFlow.ZendeskDestinationPropertiesProperty.Builder builder()

Returns:

a CfnFlow.ZendeskDestinationPropertiesProperty.Builder of CfnFlow.ZendeskDestinationPropertiesProperty