2.237.1

interface SourceFlowConfigProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.AppFlow.Mixins.CfnFlowPropsMixin.SourceFlowConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsappflow/mixins#CfnFlowPropsMixin_SourceFlowConfigProperty
Javasoftware.amazon.awscdk.mixins.preview.services.appflow.mixins.CfnFlowPropsMixin.SourceFlowConfigProperty
Pythonaws_cdk.mixins_preview.aws_appflow.mixins.CfnFlowPropsMixin.SourceFlowConfigProperty
TypeScript @aws-cdk/mixins-preview » aws_appflow » mixins » CfnFlowPropsMixin » SourceFlowConfigProperty

Contains information about the configuration of the source connector used in the flow.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceflowconfig.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as appflow_mixins } from '@aws-cdk/mixins-preview/aws-appflow';
const sourceFlowConfigProperty: appflow_mixins.CfnFlowPropsMixin.SourceFlowConfigProperty = {
  apiVersion: 'apiVersion',
  connectorProfileName: 'connectorProfileName',
  connectorType: 'connectorType',
  incrementalPullConfig: {
    datetimeTypeFieldName: 'datetimeTypeFieldName',
  },
  sourceConnectorProperties: {
    amplitude: {
      object: 'object',
    },
    customConnector: {
      customProperties: {
        customPropertiesKey: 'customProperties',
      },
      dataTransferApi: {
        name: 'name',
        type: 'type',
      },
      entityName: 'entityName',
    },
    datadog: {
      object: 'object',
    },
    dynatrace: {
      object: 'object',
    },
    googleAnalytics: {
      object: 'object',
    },
    inforNexus: {
      object: 'object',
    },
    marketo: {
      object: 'object',
    },
    pardot: {
      object: 'object',
    },
    s3: {
      bucketName: 'bucketName',
      bucketPrefix: 'bucketPrefix',
      s3InputFormatConfig: {
        s3InputFileType: 's3InputFileType',
      },
    },
    salesforce: {
      dataTransferApi: 'dataTransferApi',
      enableDynamicFieldUpdate: false,
      includeDeletedRecords: false,
      object: 'object',
    },
    sapoData: {
      objectPath: 'objectPath',
      paginationConfig: {
        maxPageSize: 123,
      },
      parallelismConfig: {
        maxParallelism: 123,
      },
    },
    serviceNow: {
      object: 'object',
    },
    singular: {
      object: 'object',
    },
    slack: {
      object: 'object',
    },
    trendmicro: {
      object: 'object',
    },
    veeva: {
      documentType: 'documentType',
      includeAllVersions: false,
      includeRenditions: false,
      includeSourceFiles: false,
      object: 'object',
    },
    zendesk: {
      object: 'object',
    },
  },
};

Properties

NameTypeDescription
apiVersion?stringThe API version of the connector when it's used as a source in the flow.
connectorProfileName?stringThe name of the connector profile.
connectorType?stringThe type of connector, such as Salesforce, Amplitude, and so on.
incrementalPullConfig?IResolvable | IncrementalPullConfigPropertyDefines the configuration for a scheduled incremental data pull.
sourceConnectorProperties?IResolvable | SourceConnectorPropertiesPropertySpecifies the information that is required to query a particular source connector.

apiVersion?

Type: string (optional)

The API version of the connector when it's used as a source in the flow.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceflowconfig.html#cfn-appflow-flow-sourceflowconfig-apiversion

connectorProfileName?

Type: string (optional)

The name of the connector profile.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceflowconfig.html#cfn-appflow-flow-sourceflowconfig-connectorprofilename

connectorType?

Type: string (optional)

The type of connector, such as Salesforce, Amplitude, and so on.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceflowconfig.html#cfn-appflow-flow-sourceflowconfig-connectortype

incrementalPullConfig?

Type: IResolvable | IncrementalPullConfigProperty (optional)

Defines the configuration for a scheduled incremental data pull.

If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceflowconfig.html#cfn-appflow-flow-sourceflowconfig-incrementalpullconfig

sourceConnectorProperties?

Type: IResolvable | SourceConnectorPropertiesProperty (optional)

Specifies the information that is required to query a particular source connector.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceflowconfig.html#cfn-appflow-flow-sourceflowconfig-sourceconnectorproperties

← PreviousNext →