Interface ICfnFlowMixinProps

Properties for CfnFlowPropsMixin.

Namespace: Amazon.CDK.Mixins.Preview.AWS.AppFlow.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface ICfnFlowMixinProps

Syntax (vb)

Public Interface ICfnFlowMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.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.Mixins.Preview.AWS.AppFlow.Mixins;

             var cfnFlowMixinProps = new CfnFlowMixinProps {
                 Description = "description",
                 DestinationFlowConfigList = new [] { new DestinationFlowConfigProperty {
                     ApiVersion = "apiVersion",
                     ConnectorProfileName = "connectorProfileName",
                     ConnectorType = "connectorType",
                     DestinationConnectorProperties = new DestinationConnectorPropertiesProperty {
                         CustomConnector = new CustomConnectorDestinationPropertiesProperty {
                             CustomProperties = new Dictionary<string, string> {
                                 { "customPropertiesKey", "customProperties" }
                             },
                             EntityName = "entityName",
                             ErrorHandlingConfig = new ErrorHandlingConfigProperty {
                                 BucketName = "bucketName",
                                 BucketPrefix = "bucketPrefix",
                                 FailOnFirstError = false
                             },
                             IdFieldNames = new [] { "idFieldNames" },
                             WriteOperationType = "writeOperationType"
                         },
                         EventBridge = new EventBridgeDestinationPropertiesProperty {
                             ErrorHandlingConfig = new ErrorHandlingConfigProperty {
                                 BucketName = "bucketName",
                                 BucketPrefix = "bucketPrefix",
                                 FailOnFirstError = false
                             },
                             Object = "object"
                         },
                         LookoutMetrics = new LookoutMetricsDestinationPropertiesProperty {
                             Object = "object"
                         },
                         Marketo = new MarketoDestinationPropertiesProperty {
                             ErrorHandlingConfig = new ErrorHandlingConfigProperty {
                                 BucketName = "bucketName",
                                 BucketPrefix = "bucketPrefix",
                                 FailOnFirstError = false
                             },
                             Object = "object"
                         },
                         Redshift = new RedshiftDestinationPropertiesProperty {
                             BucketPrefix = "bucketPrefix",
                             ErrorHandlingConfig = new ErrorHandlingConfigProperty {
                                 BucketName = "bucketName",
                                 BucketPrefix = "bucketPrefix",
                                 FailOnFirstError = false
                             },
                             IntermediateBucketName = "intermediateBucketName",
                             Object = "object"
                         },
                         S3 = new S3DestinationPropertiesProperty {
                             BucketName = "bucketName",
                             BucketPrefix = "bucketPrefix",
                             S3OutputFormatConfig = new S3OutputFormatConfigProperty {
                                 AggregationConfig = new AggregationConfigProperty {
                                     AggregationType = "aggregationType",
                                     TargetFileSize = 123
                                 },
                                 FileType = "fileType",
                                 PrefixConfig = new PrefixConfigProperty {
                                     PathPrefixHierarchy = new [] { "pathPrefixHierarchy" },
                                     PrefixFormat = "prefixFormat",
                                     PrefixType = "prefixType"
                                 },
                                 PreserveSourceDataTyping = false
                             }
                         },
                         Salesforce = new SalesforceDestinationPropertiesProperty {
                             DataTransferApi = "dataTransferApi",
                             ErrorHandlingConfig = new ErrorHandlingConfigProperty {
                                 BucketName = "bucketName",
                                 BucketPrefix = "bucketPrefix",
                                 FailOnFirstError = false
                             },
                             IdFieldNames = new [] { "idFieldNames" },
                             Object = "object",
                             WriteOperationType = "writeOperationType"
                         },
                         SapoData = new SAPODataDestinationPropertiesProperty {
                             ErrorHandlingConfig = new ErrorHandlingConfigProperty {
                                 BucketName = "bucketName",
                                 BucketPrefix = "bucketPrefix",
                                 FailOnFirstError = false
                             },
                             IdFieldNames = new [] { "idFieldNames" },
                             ObjectPath = "objectPath",
                             SuccessResponseHandlingConfig = new SuccessResponseHandlingConfigProperty {
                                 BucketName = "bucketName",
                                 BucketPrefix = "bucketPrefix"
                             },
                             WriteOperationType = "writeOperationType"
                         },
                         Snowflake = new SnowflakeDestinationPropertiesProperty {
                             BucketPrefix = "bucketPrefix",
                             ErrorHandlingConfig = new ErrorHandlingConfigProperty {
                                 BucketName = "bucketName",
                                 BucketPrefix = "bucketPrefix",
                                 FailOnFirstError = false
                             },
                             IntermediateBucketName = "intermediateBucketName",
                             Object = "object"
                         },
                         Upsolver = new UpsolverDestinationPropertiesProperty {
                             BucketName = "bucketName",
                             BucketPrefix = "bucketPrefix",
                             S3OutputFormatConfig = new UpsolverS3OutputFormatConfigProperty {
                                 AggregationConfig = new AggregationConfigProperty {
                                     AggregationType = "aggregationType",
                                     TargetFileSize = 123
                                 },
                                 FileType = "fileType",
                                 PrefixConfig = new PrefixConfigProperty {
                                     PathPrefixHierarchy = new [] { "pathPrefixHierarchy" },
                                     PrefixFormat = "prefixFormat",
                                     PrefixType = "prefixType"
                                 }
                             }
                         },
                         Zendesk = new ZendeskDestinationPropertiesProperty {
                             ErrorHandlingConfig = new ErrorHandlingConfigProperty {
                                 BucketName = "bucketName",
                                 BucketPrefix = "bucketPrefix",
                                 FailOnFirstError = false
                             },
                             IdFieldNames = new [] { "idFieldNames" },
                             Object = "object",
                             WriteOperationType = "writeOperationType"
                         }
                     }
                 } },
                 FlowName = "flowName",
                 FlowStatus = "flowStatus",
                 KmsArn = "kmsArn",
                 MetadataCatalogConfig = new MetadataCatalogConfigProperty {
                     GlueDataCatalog = new GlueDataCatalogProperty {
                         DatabaseName = "databaseName",
                         RoleArn = "roleArn",
                         TablePrefix = "tablePrefix"
                     }
                 },
                 SourceFlowConfig = new SourceFlowConfigProperty {
                     ApiVersion = "apiVersion",
                     ConnectorProfileName = "connectorProfileName",
                     ConnectorType = "connectorType",
                     IncrementalPullConfig = new IncrementalPullConfigProperty {
                         DatetimeTypeFieldName = "datetimeTypeFieldName"
                     },
                     SourceConnectorProperties = new SourceConnectorPropertiesProperty {
                         Amplitude = new AmplitudeSourcePropertiesProperty {
                             Object = "object"
                         },
                         CustomConnector = new CustomConnectorSourcePropertiesProperty {
                             CustomProperties = new Dictionary<string, string> {
                                 { "customPropertiesKey", "customProperties" }
                             },
                             DataTransferApi = new DataTransferApiProperty {
                                 Name = "name",
                                 Type = "type"
                             },
                             EntityName = "entityName"
                         },
                         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",
                             S3InputFormatConfig = new S3InputFormatConfigProperty {
                                 S3InputFileType = "s3InputFileType"
                             }
                         },
                         Salesforce = new SalesforceSourcePropertiesProperty {
                             DataTransferApi = "dataTransferApi",
                             EnableDynamicFieldUpdate = false,
                             IncludeDeletedRecords = false,
                             Object = "object"
                         },
                         SapoData = new SAPODataSourcePropertiesProperty {
                             ObjectPath = "objectPath",
                             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 {
                             DocumentType = "documentType",
                             IncludeAllVersions = false,
                             IncludeRenditions = false,
                             IncludeSourceFiles = false,
                             Object = "object"
                         },
                         Zendesk = new ZendeskSourcePropertiesProperty {
                             Object = "object"
                         }
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Tasks = new [] { new TaskProperty {
                     ConnectorOperator = new ConnectorOperatorProperty {
                         Amplitude = "amplitude",
                         CustomConnector = "customConnector",
                         Datadog = "datadog",
                         Dynatrace = "dynatrace",
                         GoogleAnalytics = "googleAnalytics",
                         InforNexus = "inforNexus",
                         Marketo = "marketo",
                         Pardot = "pardot",
                         S3 = "s3",
                         Salesforce = "salesforce",
                         SapoData = "sapoData",
                         ServiceNow = "serviceNow",
                         Singular = "singular",
                         Slack = "slack",
                         Trendmicro = "trendmicro",
                         Veeva = "veeva",
                         Zendesk = "zendesk"
                     },
                     DestinationField = "destinationField",
                     SourceFields = new [] { "sourceFields" },
                     TaskProperties = new [] { new TaskPropertiesObjectProperty {
                         Key = "key",
                         Value = "value"
                     } },
                     TaskType = "taskType"
                 } },
                 TriggerConfig = new TriggerConfigProperty {
                     TriggerProperties = new ScheduledTriggerPropertiesProperty {
                         DataPullMode = "dataPullMode",
                         FirstExecutionFrom = 123,
                         FlowErrorDeactivationThreshold = 123,
                         ScheduleEndTime = 123,
                         ScheduleExpression = "scheduleExpression",
                         ScheduleOffset = 123,
                         ScheduleStartTime = 123,
                         TimeZone = "timeZone"
                     },
                     TriggerType = "triggerType"
                 }
             };

Synopsis

Properties

Description	A user-entered description of the flow.
DestinationFlowConfigList	The configuration that controls how Amazon AppFlow places data in the destination connector.
FlowName	The specified name of the flow.
FlowStatus	Sets the status of the flow. You can specify one of the following values:.
KmsArn	The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
MetadataCatalogConfig	Specifies the configuration that Amazon AppFlow uses when it catalogs your data.
SourceFlowConfig	Contains information about the configuration of the source connector used in the flow.
Tags	The tags used to organize, track, or control access for your flow.
Tasks	A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
TriggerConfig	The trigger settings that determine how and when Amazon AppFlow runs the specified flow.

Properties

Description

A user-entered description of the flow.

string? Description { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-description

DestinationFlowConfigList

The configuration that controls how Amazon AppFlow places data in the destination connector.

object? DestinationFlowConfigList { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-destinationflowconfiglist

Type union: either IResolvable or (either IResolvable or CfnFlowPropsMixin.IDestinationFlowConfigProperty)[]

FlowName

The specified name of the flow.

string? FlowName { get; }

Property Value

string

Remarks

Spaces are not allowed. Use underscores (_) or hyphens (-) only.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-flowname

FlowStatus

Sets the status of the flow. You can specify one of the following values:.

string? FlowStatus { get; }

Property Value

string

Remarks

If you omit the FlowStatus parameter, Amazon AppFlow creates the flow with a default status. The default status for on-demand flows is Active. The default status for scheduled and event-triggered flows is Draft, which means they’re not yet active.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-flowstatus

KmsArn

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.

string? KmsArn { get; }

Property Value

string

Remarks

This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-kmsarn