aws-cdk-lib.aws_appflow.CfnFlow.DestinationFlowConfigProperty

interface DestinationFlowConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.AppFlow.CfnFlow.DestinationFlowConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappflow#CfnFlow_DestinationFlowConfigProperty
Javasoftware.amazon.awscdk.services.appflow.CfnFlow.DestinationFlowConfigProperty
Pythonaws_cdk.aws_appflow.CfnFlow.DestinationFlowConfigProperty
TypeScript aws-cdk-lib » aws_appflow » CfnFlow » DestinationFlowConfigProperty

Contains information about the configuration of destination connectors present in the flow.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appflow as appflow } from 'aws-cdk-lib';
const destinationFlowConfigProperty: appflow.CfnFlow.DestinationFlowConfigProperty = {
  connectorType: 'connectorType',
  destinationConnectorProperties: {
    customConnector: {
      entityName: 'entityName',

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

      // the properties below are optional
      errorHandlingConfig: {
        bucketName: 'bucketName',
        bucketPrefix: 'bucketPrefix',
        failOnFirstError: false,
      },
    },
    lookoutMetrics: {
      object: 'object',
    },
    marketo: {
      object: 'object',

      // the properties below are optional
      errorHandlingConfig: {
        bucketName: 'bucketName',
        bucketPrefix: 'bucketPrefix',
        failOnFirstError: false,
      },
    },
    redshift: {
      intermediateBucketName: 'intermediateBucketName',
      object: 'object',

      // the properties below are optional
      bucketPrefix: 'bucketPrefix',
      errorHandlingConfig: {
        bucketName: 'bucketName',
        bucketPrefix: 'bucketPrefix',
        failOnFirstError: false,
      },
    },
    s3: {
      bucketName: 'bucketName',

      // the properties below are optional
      bucketPrefix: 'bucketPrefix',
      s3OutputFormatConfig: {
        aggregationConfig: {
          aggregationType: 'aggregationType',
          targetFileSize: 123,
        },
        fileType: 'fileType',
        prefixConfig: {
          pathPrefixHierarchy: ['pathPrefixHierarchy'],
          prefixFormat: 'prefixFormat',
          prefixType: 'prefixType',
        },
        preserveSourceDataTyping: false,
      },
    },
    salesforce: {
      object: 'object',

      // the properties below are optional
      dataTransferApi: 'dataTransferApi',
      errorHandlingConfig: {
        bucketName: 'bucketName',
        bucketPrefix: 'bucketPrefix',
        failOnFirstError: false,
      },
      idFieldNames: ['idFieldNames'],
      writeOperationType: 'writeOperationType',
    },
    sapoData: {
      objectPath: 'objectPath',

      // the properties below are optional
      errorHandlingConfig: {
        bucketName: 'bucketName',
        bucketPrefix: 'bucketPrefix',
        failOnFirstError: false,
      },
      idFieldNames: ['idFieldNames'],
      successResponseHandlingConfig: {
        bucketName: 'bucketName',
        bucketPrefix: 'bucketPrefix',
      },
      writeOperationType: 'writeOperationType',
    },
    snowflake: {
      intermediateBucketName: 'intermediateBucketName',
      object: 'object',

      // the properties below are optional
      bucketPrefix: 'bucketPrefix',
      errorHandlingConfig: {
        bucketName: 'bucketName',
        bucketPrefix: 'bucketPrefix',
        failOnFirstError: false,
      },
    },
    upsolver: {
      bucketName: 'bucketName',
      s3OutputFormatConfig: {
        prefixConfig: {
          pathPrefixHierarchy: ['pathPrefixHierarchy'],
          prefixFormat: 'prefixFormat',
          prefixType: 'prefixType',
        },

        // the properties below are optional
        aggregationConfig: {
          aggregationType: 'aggregationType',
          targetFileSize: 123,
        },
        fileType: 'fileType',
      },

      // the properties below are optional
      bucketPrefix: 'bucketPrefix',
    },
    zendesk: {
      object: 'object',

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

  // the properties below are optional
  apiVersion: 'apiVersion',
  connectorProfileName: 'connectorProfileName',
};

Properties

NameTypeDescription
connectorTypestringThe type of destination connector, such as Sales force, Amazon S3, and so on.
destinationConnectorPropertiesIResolvable | DestinationConnectorPropertiesPropertyThis stores the information that is required to query a particular connector.
apiVersion?stringThe API version that the destination connector uses.
connectorProfileName?stringThe name of the connector profile.

connectorType

Type: string

The type of destination connector, such as Sales force, Amazon S3, and so on.

Allowed Values : EventBridge | Redshift | S3 | Salesforce | Snowflake


destinationConnectorProperties

Type: IResolvable | DestinationConnectorPropertiesProperty

This stores the information that is required to query a particular connector.


apiVersion?

Type: string (optional)

The API version that the destination connector uses.


connectorProfileName?

Type: string (optional)

The name of the connector profile.

This name must be unique for each connector profile in the AWS account .