Package software.amazon.awscdk.services.appflow

Interface CfnFlow.CustomConnectorDestinationPropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.CustomConnectorDestinationPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnFlow

@Stability(Stable)
public static interface CfnFlow.CustomConnectorDestinationPropertiesProperty
extends software.amazon.jsii.JsiiSerializable

The properties that are applied when the custom connector 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.*;
 CustomConnectorDestinationPropertiesProperty customConnectorDestinationPropertiesProperty = CustomConnectorDestinationPropertiesProperty.builder()
         .entityName("entityName")
         // the properties below are optional
         .customProperties(Map.of(
                 "customPropertiesKey", "customProperties"))
         .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                 .bucketName("bucketName")
                 .bucketPrefix("bucketPrefix")
                 .failOnFirstError(false)
                 .build())
         .idFieldNames(List.of("idFieldNames"))
         .writeOperationType("writeOperationType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlow.CustomConnectorDestinationPropertiesProperty.Builder	builder()
default Object	getCustomProperties()	The custom properties that are specific to the connector when it's used as a destination in the flow.
String	getEntityName()	The entity specified in the custom connector as a destination in the flow.
default Object	getErrorHandlingConfig()	The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination.
default List<String>	getIdFieldNames()	The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete, or upsert.
default String	getWriteOperationType()	Specifies the type of write operation to be performed in the custom connector when it's used as destination.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEntityName

@Stability(Stable)
@NotNull
String getEntityName()

The entity specified in the custom connector as a destination in the flow.

See Also:

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

getCustomProperties

@Stability(Stable)
@Nullable
default Object getCustomProperties()

The custom properties that are specific to the connector when it's used as a destination in the flow.

See Also:

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

getErrorHandlingConfig

@Stability(Stable)
@Nullable
default Object getErrorHandlingConfig()

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

See Also:

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

getIdFieldNames

@Stability(Stable)
@Nullable
default List<String> getIdFieldNames()

The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete, or upsert.

See Also:

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

getWriteOperationType

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

Specifies the type of write operation to be performed in the custom connector when it's used as destination.

See Also:

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

builder

@Stability(Stable)
static CfnFlow.CustomConnectorDestinationPropertiesProperty.Builder builder()

Returns:

a CfnFlow.CustomConnectorDestinationPropertiesProperty.Builder of CfnFlow.CustomConnectorDestinationPropertiesProperty