1.204.0

interface CustomConnectorDestinationPropertiesProperty

LanguageType name
.NETAmazon.CDK.AWS.AppFlow.CfnFlow.CustomConnectorDestinationPropertiesProperty
Javasoftware.amazon.awscdk.services.appflow.CfnFlow.CustomConnectorDestinationPropertiesProperty
Pythonaws_cdk.aws_appflow.CfnFlow.CustomConnectorDestinationPropertiesProperty
TypeScript @aws-cdk/aws-appflow » CfnFlow » CustomConnectorDestinationPropertiesProperty

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 * as appflow from '@aws-cdk/aws-appflow';
const customConnectorDestinationPropertiesProperty: appflow.CfnFlow.CustomConnectorDestinationPropertiesProperty = {
  entityName: 'entityName',

  // the properties below are optional
  customProperties: {
    customPropertiesKey: 'customProperties',
  },
  errorHandlingConfig: {
    bucketName: 'bucketName',
    bucketPrefix: 'bucketPrefix',
    failOnFirstError: false,
  },
  idFieldNames: ['idFieldNames'],
  writeOperationType: 'writeOperationType',
};

Properties

NameTypeDescription
entityNamestringThe entity specified in the custom connector as a destination in the flow.
customProperties?IResolvable | { [string]: string }The custom properties that are specific to the connector when it's used as a destination in the flow.
errorHandlingConfig?IResolvable | ErrorHandlingConfigPropertyThe settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination.
idFieldNames?string[]The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete, or upsert.
writeOperationType?stringSpecifies the type of write operation to be performed in the custom connector when it's used as destination.

entityName

Type: string

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

customProperties?

Type: IResolvable | { [string]: string } (optional)

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

errorHandlingConfig?

Type: IResolvable | ErrorHandlingConfigProperty (optional)

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

idFieldNames?

Type: string[] (optional)

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

writeOperationType?

Type: string (optional)

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

← PreviousNext →