interface FlowDefinitionProperty

Language	Type name
.NET	`Amazon.CDK.AWS.CustomerProfiles.CfnIntegration.FlowDefinitionProperty`
Java	`software.amazon.awscdk.services.customerprofiles.CfnIntegration.FlowDefinitionProperty`
Python	`aws_cdk.aws_customerprofiles.CfnIntegration.FlowDefinitionProperty`
TypeScript	`@aws-cdk/aws-customerprofiles` » `CfnIntegration` » `FlowDefinitionProperty`

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as customerprofiles from '@aws-cdk/aws-customerprofiles';
const flowDefinitionProperty: customerprofiles.CfnIntegration.FlowDefinitionProperty = {
  flowName: 'flowName',
  kmsArn: 'kmsArn',
  sourceFlowConfig: {
    connectorType: 'connectorType',
    sourceConnectorProperties: {
      marketo: {
        object: 'object',
      },
      s3: {
        bucketName: 'bucketName',

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

        // the properties below are optional
        enableDynamicFieldUpdate: false,
        includeDeletedRecords: false,
      },
      serviceNow: {
        object: 'object',
      },
      zendesk: {
        object: 'object',
      },
    },

    // the properties below are optional
    connectorProfileName: 'connectorProfileName',
    incrementalPullConfig: {
      datetimeTypeFieldName: 'datetimeTypeFieldName',
    },
  },
  tasks: [{
    sourceFields: ['sourceFields'],
    taskType: 'taskType',

    // the properties below are optional
    connectorOperator: {
      marketo: 'marketo',
      s3: 's3',
      salesforce: 'salesforce',
      serviceNow: 'serviceNow',
      zendesk: 'zendesk',
    },
    destinationField: 'destinationField',
    taskProperties: [{
      operatorPropertyKey: 'operatorPropertyKey',
      property: 'property',
    }],
  }],
  triggerConfig: {
    triggerType: 'triggerType',

    // the properties below are optional
    triggerProperties: {
      scheduled: {
        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',
};

Properties

Name	Type	Description
flowName	`string`	The specified name of the flow.
kmsArn	`string`	The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key you provide for encryption.
sourceFlowConfig	`IResolvable` `\|` `SourceFlowConfigProperty`	The configuration that controls how Customer Profiles retrieves data from the source.
tasks	`IResolvable` `\|` `IResolvable` `\|` `TaskProperty[]`	A list of tasks that Customer Profiles performs while transferring the data in the flow run.
triggerConfig	`IResolvable` `\|` `TriggerConfigProperty`	The trigger settings that determine how and when the flow runs.
description?	`string`	A description of the flow you want to create.

flowName

Type: string

The specified name of the flow.

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

kmsArn

Type: string

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

sourceFlowConfig

Type: IResolvable | SourceFlowConfigProperty

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

tasks

Type: IResolvable | IResolvable | TaskProperty[]

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

triggerConfig

Type: IResolvable | TriggerConfigProperty

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

description?

Type: string (optional)

A description of the flow you want to create.