Interface CfnFlow.ISourceFlowConfigProperty

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

Namespace: Amazon.CDK.AWS.AppFlow

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnFlow.ISourceFlowConfigProperty

Syntax (vb)

Public Interface CfnFlow.ISourceFlowConfigProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// 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"
                 }
             };

Synopsis

Properties

ApiVersion	The API version of the connector when it's used as a source in the flow.
ConnectorProfileName	The name of the connector profile.
ConnectorType	The type of connector, such as Salesforce, Amplitude, and so on.
IncrementalPullConfig	Defines the configuration for a scheduled incremental data pull.
SourceConnectorProperties	Specifies the information that is required to query a particular source connector.

Properties

ApiVersion

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

string? ApiVersion { get; }

Property Value

string

Remarks

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

ConnectorProfileName

The name of the connector profile.

string? ConnectorProfileName { get; }

Property Value

string

Remarks

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

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

ConnectorType

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

string ConnectorType { get; }

Property Value

string

Remarks

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

IncrementalPullConfig

Defines the configuration for a scheduled incremental data pull.

object? IncrementalPullConfig { get; }

Property Value

object

Remarks

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

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

Type union: either IResolvable or CfnFlow.IIncrementalPullConfigProperty

SourceConnectorProperties

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

object SourceConnectorProperties { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnFlow.ISourceConnectorPropertiesProperty