Interface CfnIntegration.IFlowDefinitionProperty

The configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow.

Namespace: Amazon.CDK.AWS.CustomerProfiles

Assembly: Amazon.CDK.AWS.CustomerProfiles.dll

Syntax (csharp)

public interface IFlowDefinitionProperty

Syntax (vb)

Public Interface IFlowDefinitionProperty

Remarks

Customer Profiles uses this information to create an AppFlow flow on behalf of customers.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.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.CustomerProfiles;

var flowDefinitionProperty = new FlowDefinitionProperty {
    FlowName = "flowName",
    KmsArn = "kmsArn",
    SourceFlowConfig = new SourceFlowConfigProperty {
        ConnectorType = "connectorType",
        SourceConnectorProperties = new SourceConnectorPropertiesProperty {
            Marketo = new MarketoSourcePropertiesProperty {
                Object = "object"
            },
            S3 = new S3SourcePropertiesProperty {
                BucketName = "bucketName",

                // the properties below are optional
                BucketPrefix = "bucketPrefix"
            },
            Salesforce = new SalesforceSourcePropertiesProperty {
                Object = "object",

                // the properties below are optional
                EnableDynamicFieldUpdate = false,
                IncludeDeletedRecords = false
            },
            ServiceNow = new ServiceNowSourcePropertiesProperty {
                Object = "object"
            },
            Zendesk = new ZendeskSourcePropertiesProperty {
                Object = "object"
            }
        },

        // the properties below are optional
        ConnectorProfileName = "connectorProfileName",
        IncrementalPullConfig = new IncrementalPullConfigProperty {
            DatetimeTypeFieldName = "datetimeTypeFieldName"
        }
    },
    Tasks = new [] { new TaskProperty {
        SourceFields = new [] { "sourceFields" },
        TaskType = "taskType",

        // the properties below are optional
        ConnectorOperator = new ConnectorOperatorProperty {
            Marketo = "marketo",
            S3 = "s3",
            Salesforce = "salesforce",
            ServiceNow = "serviceNow",
            Zendesk = "zendesk"
        },
        DestinationField = "destinationField",
        TaskProperties = new [] { new TaskPropertiesMapProperty {
            OperatorPropertyKey = "operatorPropertyKey",
            Property = "property"
        } }
    } },
    TriggerConfig = new TriggerConfigProperty {
        TriggerType = "triggerType",

        // the properties below are optional
        TriggerProperties = new TriggerPropertiesProperty {
            Scheduled = new ScheduledTriggerPropertiesProperty {
                ScheduleExpression = "scheduleExpression",

                // the properties below are optional
                DataPullMode = "dataPullMode",
                FirstExecutionFrom = 123,
                ScheduleEndTime = 123,
                ScheduleOffset = 123,
                ScheduleStartTime = 123,
                Timezone = "timezone"
            }
        }
    },

    // the properties below are optional
    Description = "description"
};

Synopsis

Properties

Description	A description of the flow you want to create.
FlowName	The specified name of the flow.
KmsArn	The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key you provide for encryption.
SourceFlowConfig	The configuration that controls how Customer Profiles retrieves data from the source.
Tasks	A list of tasks that Customer Profiles performs while transferring the data in the flow run.
TriggerConfig	The trigger settings that determine how and when the flow runs.

Properties

Description

A description of the flow you want to create.

virtual string Description { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-description

FlowName

The specified name of the flow.

string FlowName { get; }

Property Value

System.String

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-flowname

KmsArn

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

string KmsArn { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-kmsarn

SourceFlowConfig

The configuration that controls how Customer Profiles retrieves data from the source.

object SourceFlowConfig { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-sourceflowconfig

Tasks

A list of tasks that Customer Profiles performs while transferring the data in the flow run.

object Tasks { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-tasks

TriggerConfig

The trigger settings that determine how and when the flow runs.

object TriggerConfig { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-triggerconfig