Package software.amazon.awscdk.cfnpropertymixins.services.appflow

Interface CfnFlowPropsMixin.ZendeskDestinationPropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlowPropsMixin.ZendeskDestinationPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnFlowPropsMixin

@Stability(Stable)
public static interface CfnFlowPropsMixin.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.cfnpropertymixins.services.appflow.*;
 ZendeskDestinationPropertiesProperty zendeskDestinationPropertiesProperty = ZendeskDestinationPropertiesProperty.builder()
         .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                 .bucketName("bucketName")
                 .bucketPrefix("bucketPrefix")
                 .failOnFirstError(false)
                 .build())
         .idFieldNames(List.of("idFieldNames"))
         .object("object")
         .writeOperationType("writeOperationType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlowPropsMixin.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.
default 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 Details

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.

Returns union: either IResolvable or CfnFlowPropsMixin.ErrorHandlingConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html#cfn-appflow-flow-zendeskdestinationproperties-errorhandlingconfig

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html#cfn-appflow-flow-zendeskdestinationproperties-idfieldnames

getObject

@Stability(Stable)
@Nullable
default String getObject()

The object specified in the Zendesk flow destination.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html#cfn-appflow-flow-zendeskdestinationproperties-object

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html#cfn-appflow-flow-zendeskdestinationproperties-writeoperationtype

builder

@Stability(Stable)
static CfnFlowPropsMixin.ZendeskDestinationPropertiesProperty.Builder builder()

Returns:

a CfnFlowPropsMixin.ZendeskDestinationPropertiesProperty.Builder of CfnFlowPropsMixin.ZendeskDestinationPropertiesProperty