Skip to content
v2.277.0

SourceFlowConfigProperty Struct ​

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

Example ​

ts
// 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 sourceFlowConfigProperty: appflow.CfnFlow.SourceFlowConfigProperty = {
  connectorType: 'connectorType',
  sourceConnectorProperties: {
    amplitude: {
      object: 'object',
    },
    customConnector: {
      entityName: 'entityName',

      // the properties below are optional
      customProperties: {
        customPropertiesKey: 'customProperties',
      },
      dataTransferApi: {
        name: 'name',
        type: 'type',
      },
    },
    datadog: {
      object: 'object',
    },
    dynatrace: {
      object: 'object',
    },
    googleAnalytics: {
      object: 'object',
    },
    inforNexus: {
      object: 'object',
    },
    marketo: {
      object: 'object',
    },
    pardot: {
      object: 'object',
    },
    s3: {
      bucketName: 'bucketName',
      bucketPrefix: 'bucketPrefix',

      // the properties below are optional
      s3InputFormatConfig: {
        s3InputFileType: 's3InputFileType',
      },
    },
    salesforce: {
      object: 'object',

      // the properties below are optional
      dataTransferApi: 'dataTransferApi',
      enableDynamicFieldUpdate: false,
      includeDeletedRecords: false,
    },
    sapoData: {
      objectPath: 'objectPath',

      // the properties below are optional
      paginationConfig: {
        maxPageSize: 123,
      },
      parallelismConfig: {
        maxParallelism: 123,
      },
    },
    serviceNow: {
      object: 'object',
    },
    singular: {
      object: 'object',
    },
    slack: {
      object: 'object',
    },
    trendmicro: {
      object: 'object',
    },
    veeva: {
      object: 'object',

      // the properties below are optional
      documentType: 'documentType',
      includeAllVersions: false,
      includeRenditions: false,
      includeSourceFiles: false,
    },
    zendesk: {
      object: 'object',
    },
  },

  // the properties below are optional
  apiVersion: 'apiVersion',
  connectorProfileName: 'connectorProfileName',
  incrementalPullConfig: {
    datetimeTypeFieldName: 'datetimeTypeFieldName',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appflow as appflow

source_flow_config_property = appflow.CfnFlow.SourceFlowConfigProperty(
    connector_type="connectorType",
    source_connector_properties=appflow.CfnFlow.SourceConnectorPropertiesProperty(
        amplitude=appflow.CfnFlow.AmplitudeSourcePropertiesProperty(
            object="object"
        ),
        custom_connector=appflow.CfnFlow.CustomConnectorSourcePropertiesProperty(
            entity_name="entityName",

            # the properties below are optional
            custom_properties={
                "custom_properties_key": "customProperties"
            },
            data_transfer_api=appflow.CfnFlow.DataTransferApiProperty(
                name="name",
                type="type"
            )
        ),
        datadog=appflow.CfnFlow.DatadogSourcePropertiesProperty(
            object="object"
        ),
        dynatrace=appflow.CfnFlow.DynatraceSourcePropertiesProperty(
            object="object"
        ),
        google_analytics=appflow.CfnFlow.GoogleAnalyticsSourcePropertiesProperty(
            object="object"
        ),
        infor_nexus=appflow.CfnFlow.InforNexusSourcePropertiesProperty(
            object="object"
        ),
        marketo=appflow.CfnFlow.MarketoSourcePropertiesProperty(
            object="object"
        ),
        pardot=appflow.CfnFlow.PardotSourcePropertiesProperty(
            object="object"
        ),
        s3=appflow.CfnFlow.S3SourcePropertiesProperty(
            bucket_name="bucketName",
            bucket_prefix="bucketPrefix",

            # the properties below are optional
            s3_input_format_config=appflow.CfnFlow.S3InputFormatConfigProperty(
                s3_input_file_type="s3InputFileType"
            )
        ),
        salesforce=appflow.CfnFlow.SalesforceSourcePropertiesProperty(
            object="object",

            # the properties below are optional
            data_transfer_api="dataTransferApi",
            enable_dynamic_field_update=False,
            include_deleted_records=False
        ),
        sapo_data=appflow.CfnFlow.SAPODataSourcePropertiesProperty(
            object_path="objectPath",

            # the properties below are optional
            pagination_config=appflow.CfnFlow.SAPODataPaginationConfigProperty(
                max_page_size=123
            ),
            parallelism_config=appflow.CfnFlow.SAPODataParallelismConfigProperty(
                max_parallelism=123
            )
        ),
        service_now=appflow.CfnFlow.ServiceNowSourcePropertiesProperty(
            object="object"
        ),
        singular=appflow.CfnFlow.SingularSourcePropertiesProperty(
            object="object"
        ),
        slack=appflow.CfnFlow.SlackSourcePropertiesProperty(
            object="object"
        ),
        trendmicro=appflow.CfnFlow.TrendmicroSourcePropertiesProperty(
            object="object"
        ),
        veeva=appflow.CfnFlow.VeevaSourcePropertiesProperty(
            object="object",

            # the properties below are optional
            document_type="documentType",
            include_all_versions=False,
            include_renditions=False,
            include_source_files=False
        ),
        zendesk=appflow.CfnFlow.ZendeskSourcePropertiesProperty(
            object="object"
        )
    ),

    # the properties below are optional
    api_version="apiVersion",
    connector_profile_name="connectorProfileName",
    incremental_pull_config=appflow.CfnFlow.IncrementalPullConfigProperty(
        datetime_type_field_name="datetimeTypeFieldName"
    )
)
java
// 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.*;

SourceFlowConfigProperty sourceFlowConfigProperty = SourceFlowConfigProperty.builder()
        .connectorType("connectorType")
        .sourceConnectorProperties(SourceConnectorPropertiesProperty.builder()
                .amplitude(AmplitudeSourcePropertiesProperty.builder()
                        .object("object")
                        .build())
                .customConnector(CustomConnectorSourcePropertiesProperty.builder()
                        .entityName("entityName")

                        // the properties below are optional
                        .customProperties(Map.of(
                                "customPropertiesKey", "customProperties"))
                        .dataTransferApi(DataTransferApiProperty.builder()
                                .name("name")
                                .type("type")
                                .build())
                        .build())
                .datadog(DatadogSourcePropertiesProperty.builder()
                        .object("object")
                        .build())
                .dynatrace(DynatraceSourcePropertiesProperty.builder()
                        .object("object")
                        .build())
                .googleAnalytics(GoogleAnalyticsSourcePropertiesProperty.builder()
                        .object("object")
                        .build())
                .inforNexus(InforNexusSourcePropertiesProperty.builder()
                        .object("object")
                        .build())
                .marketo(MarketoSourcePropertiesProperty.builder()
                        .object("object")
                        .build())
                .pardot(PardotSourcePropertiesProperty.builder()
                        .object("object")
                        .build())
                .s3(S3SourcePropertiesProperty.builder()
                        .bucketName("bucketName")
                        .bucketPrefix("bucketPrefix")

                        // the properties below are optional
                        .s3InputFormatConfig(S3InputFormatConfigProperty.builder()
                                .s3InputFileType("s3InputFileType")
                                .build())
                        .build())
                .salesforce(SalesforceSourcePropertiesProperty.builder()
                        .object("object")

                        // the properties below are optional
                        .dataTransferApi("dataTransferApi")
                        .enableDynamicFieldUpdate(false)
                        .includeDeletedRecords(false)
                        .build())
                .sapoData(SAPODataSourcePropertiesProperty.builder()
                        .objectPath("objectPath")

                        // the properties below are optional
                        .paginationConfig(SAPODataPaginationConfigProperty.builder()
                                .maxPageSize(123)
                                .build())
                        .parallelismConfig(SAPODataParallelismConfigProperty.builder()
                                .maxParallelism(123)
                                .build())
                        .build())
                .serviceNow(ServiceNowSourcePropertiesProperty.builder()
                        .object("object")
                        .build())
                .singular(SingularSourcePropertiesProperty.builder()
                        .object("object")
                        .build())
                .slack(SlackSourcePropertiesProperty.builder()
                        .object("object")
                        .build())
                .trendmicro(TrendmicroSourcePropertiesProperty.builder()
                        .object("object")
                        .build())
                .veeva(VeevaSourcePropertiesProperty.builder()
                        .object("object")

                        // the properties below are optional
                        .documentType("documentType")
                        .includeAllVersions(false)
                        .includeRenditions(false)
                        .includeSourceFiles(false)
                        .build())
                .zendesk(ZendeskSourcePropertiesProperty.builder()
                        .object("object")
                        .build())
                .build())

        // the properties below are optional
        .apiVersion("apiVersion")
        .connectorProfileName("connectorProfileName")
        .incrementalPullConfig(IncrementalPullConfigProperty.builder()
                .datetimeTypeFieldName("datetimeTypeFieldName")
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppFlow;

var sourceFlowConfigProperty = new SourceFlowConfigProperty {
    ConnectorType = "connectorType",
    SourceConnectorProperties = new SourceConnectorPropertiesProperty {
        Amplitude = new AmplitudeSourcePropertiesProperty {
            Object = "object"
        },
        CustomConnector = new CustomConnectorSourcePropertiesProperty {
            EntityName = "entityName",

            // the properties below are optional
            CustomProperties = new Dictionary<string, string> {
                { "customPropertiesKey", "customProperties" }
            },
            DataTransferApi = new DataTransferApiProperty {
                Name = "name",
                Type = "type"
            }
        },
        Datadog = new DatadogSourcePropertiesProperty {
            Object = "object"
        },
        Dynatrace = new DynatraceSourcePropertiesProperty {
            Object = "object"
        },
        GoogleAnalytics = new GoogleAnalyticsSourcePropertiesProperty {
            Object = "object"
        },
        InforNexus = new InforNexusSourcePropertiesProperty {
            Object = "object"
        },
        Marketo = new MarketoSourcePropertiesProperty {
            Object = "object"
        },
        Pardot = new PardotSourcePropertiesProperty {
            Object = "object"
        },
        S3 = new S3SourcePropertiesProperty {
            BucketName = "bucketName",
            BucketPrefix = "bucketPrefix",

            // the properties below are optional
            S3InputFormatConfig = new S3InputFormatConfigProperty {
                S3InputFileType = "s3InputFileType"
            }
        },
        Salesforce = new SalesforceSourcePropertiesProperty {
            Object = "object",

            // the properties below are optional
            DataTransferApi = "dataTransferApi",
            EnableDynamicFieldUpdate = false,
            IncludeDeletedRecords = false
        },
        SapoData = new SAPODataSourcePropertiesProperty {
            ObjectPath = "objectPath",

            // the properties below are optional
            PaginationConfig = new SAPODataPaginationConfigProperty {
                MaxPageSize = 123
            },
            ParallelismConfig = new SAPODataParallelismConfigProperty {
                MaxParallelism = 123
            }
        },
        ServiceNow = new ServiceNowSourcePropertiesProperty {
            Object = "object"
        },
        Singular = new SingularSourcePropertiesProperty {
            Object = "object"
        },
        Slack = new SlackSourcePropertiesProperty {
            Object = "object"
        },
        Trendmicro = new TrendmicroSourcePropertiesProperty {
            Object = "object"
        },
        Veeva = new VeevaSourcePropertiesProperty {
            Object = "object",

            // the properties below are optional
            DocumentType = "documentType",
            IncludeAllVersions = false,
            IncludeRenditions = false,
            IncludeSourceFiles = false
        },
        Zendesk = new ZendeskSourcePropertiesProperty {
            Object = "object"
        }
    },

    // the properties below are optional
    ApiVersion = "apiVersion",
    ConnectorProfileName = "connectorProfileName",
    IncrementalPullConfig = new IncrementalPullConfigProperty {
        DatetimeTypeFieldName = "datetimeTypeFieldName"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

sourceFlowConfigProperty := &SourceFlowConfigProperty{
	ConnectorType: jsii.String("connectorType"),
	SourceConnectorProperties: &SourceConnectorPropertiesProperty{
		Amplitude: &AmplitudeSourcePropertiesProperty{
			Object: jsii.String("object"),
		},
		CustomConnector: &CustomConnectorSourcePropertiesProperty{
			EntityName: jsii.String("entityName"),

			// the properties below are optional
			CustomProperties: map[string]*string{
				"customPropertiesKey": jsii.String("customProperties"),
			},
			DataTransferApi: &DataTransferApiProperty{
				Name: jsii.String("name"),
				Type: jsii.String("type"),
			},
		},
		Datadog: &DatadogSourcePropertiesProperty{
			Object: jsii.String("object"),
		},
		Dynatrace: &DynatraceSourcePropertiesProperty{
			Object: jsii.String("object"),
		},
		GoogleAnalytics: &GoogleAnalyticsSourcePropertiesProperty{
			Object: jsii.String("object"),
		},
		InforNexus: &InforNexusSourcePropertiesProperty{
			Object: jsii.String("object"),
		},
		Marketo: &MarketoSourcePropertiesProperty{
			Object: jsii.String("object"),
		},
		Pardot: &PardotSourcePropertiesProperty{
			Object: jsii.String("object"),
		},
		S3: &S3SourcePropertiesProperty{
			BucketName: jsii.String("bucketName"),
			BucketPrefix: jsii.String("bucketPrefix"),

			// the properties below are optional
			S3InputFormatConfig: &S3InputFormatConfigProperty{
				S3InputFileType: jsii.String("s3InputFileType"),
			},
		},
		Salesforce: &SalesforceSourcePropertiesProperty{
			Object: jsii.String("object"),

			// the properties below are optional
			DataTransferApi: jsii.String("dataTransferApi"),
			EnableDynamicFieldUpdate: jsii.Boolean(false),
			IncludeDeletedRecords: jsii.Boolean(false),
		},
		SapoData: &SAPODataSourcePropertiesProperty{
			ObjectPath: jsii.String("objectPath"),

			// the properties below are optional
			PaginationConfig: &SAPODataPaginationConfigProperty{
				MaxPageSize: jsii.Number(123),
			},
			ParallelismConfig: &SAPODataParallelismConfigProperty{
				MaxParallelism: jsii.Number(123),
			},
		},
		ServiceNow: &ServiceNowSourcePropertiesProperty{
			Object: jsii.String("object"),
		},
		Singular: &SingularSourcePropertiesProperty{
			Object: jsii.String("object"),
		},
		Slack: &SlackSourcePropertiesProperty{
			Object: jsii.String("object"),
		},
		Trendmicro: &TrendmicroSourcePropertiesProperty{
			Object: jsii.String("object"),
		},
		Veeva: &VeevaSourcePropertiesProperty{
			Object: jsii.String("object"),

			// the properties below are optional
			DocumentType: jsii.String("documentType"),
			IncludeAllVersions: jsii.Boolean(false),
			IncludeRenditions: jsii.Boolean(false),
			IncludeSourceFiles: jsii.Boolean(false),
		},
		Zendesk: &ZendeskSourcePropertiesProperty{
			Object: jsii.String("object"),
		},
	},

	// the properties below are optional
	ApiVersion: jsii.String("apiVersion"),
	ConnectorProfileName: jsii.String("connectorProfileName"),
	IncrementalPullConfig: &IncrementalPullConfigProperty{
		DatetimeTypeFieldName: jsii.String("datetimeTypeFieldName"),
	},
}

Properties ​

apiVersionoptionalstringapi_versionoptionalstrapiVersionoptionalStringApiVersionoptionalstringApiVersionoptional*string#
The API version of the connector when it's used as a source in the flow.
connectorProfileNameoptionalstringconnector_profile_nameoptionalstrconnectorProfileNameoptionalStringConnectorProfileNameoptionalstringConnectorProfileNameoptional*string#
The name of the connector profile.

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

connectorTypestringconnector_typestrconnectorTypeStringConnectorTypestringConnectorType*stringrequired#
The type of connector, such as Salesforce, Amplitude, and so on.
incrementalPullConfigoptionalIResolvable | CfnFlow.IncrementalPullConfigPropertyincremental_pull_configoptionaltyping.Union[IResolvable, IncrementalPullConfigProperty]incrementalPullConfigoptionalIResolvableIncrementalPullConfigoptionalIResolvableIncrementalPullConfigoptionalinterface{}#
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.

sourceConnectorPropertiesIResolvable | CfnFlow.SourceConnectorPropertiesPropertysource_connector_propertiestyping.Union[IResolvable, SourceConnectorPropertiesProperty]sourceConnectorPropertiesIResolvableSourceConnectorPropertiesIResolvableSourceConnectorPropertiesinterface{}required#
Specifies the information that is required to query a particular source connector.