interface FlowDefinitionProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CustomerProfiles.Mixins.CfnIntegrationPropsMixin.FlowDefinitionProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscustomerprofiles/mixins#CfnIntegrationPropsMixin_FlowDefinitionProperty
Java	software.amazon.awscdk.mixins.preview.services.customerprofiles.mixins.CfnIntegrationPropsMixin.FlowDefinitionProperty
Python	aws_cdk.mixins_preview.aws_customerprofiles.mixins.CfnIntegrationPropsMixin.FlowDefinitionProperty
TypeScript	@aws-cdk/mixins-preview » aws_customerprofiles » mixins » CfnIntegrationPropsMixin » 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as customerprofiles_mixins } from '@aws-cdk/mixins-preview/aws-customerprofiles';
const flowDefinitionProperty: customerprofiles_mixins.CfnIntegrationPropsMixin.FlowDefinitionProperty = {
  description: 'description',
  flowName: 'flowName',
  kmsArn: 'kmsArn',
  sourceFlowConfig: {
    connectorProfileName: 'connectorProfileName',
    connectorType: 'connectorType',
    incrementalPullConfig: {
      datetimeTypeFieldName: 'datetimeTypeFieldName',
    },
    sourceConnectorProperties: {
      marketo: {
        object: 'object',
      },
      s3: {
        bucketName: 'bucketName',
        bucketPrefix: 'bucketPrefix',
      },
      salesforce: {
        enableDynamicFieldUpdate: false,
        includeDeletedRecords: false,
        object: 'object',
      },
      serviceNow: {
        object: 'object',
      },
      zendesk: {
        object: 'object',
      },
    },
  },
  tasks: [{
    connectorOperator: {
      marketo: 'marketo',
      s3: 's3',
      salesforce: 'salesforce',
      serviceNow: 'serviceNow',
      zendesk: 'zendesk',
    },
    destinationField: 'destinationField',
    sourceFields: ['sourceFields'],
    taskProperties: [{
      operatorPropertyKey: 'operatorPropertyKey',
      property: 'property',
    }],
    taskType: 'taskType',
  }],
  triggerConfig: {
    triggerProperties: {
      scheduled: {
        dataPullMode: 'dataPullMode',
        firstExecutionFrom: 123,
        scheduleEndTime: 123,
        scheduleExpression: 'scheduleExpression',
        scheduleOffset: 123,
        scheduleStartTime: 123,
        timezone: 'timezone',
      },
    },
    triggerType: 'triggerType',
  },
};

Properties

Name	Type	Description
description?	string	A description of the flow you want to create.
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?

Type: string (optional)

A description of the flow you want to create.

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

---

flowName?

Type: string (optional)

The specified name of the flow.

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

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

---

kmsArn?

Type: string (optional)

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

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

---

sourceFlowConfig?

Type: IResolvable | SourceFlowConfigProperty (optional)

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

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

---

tasks?

Type: IResolvable | (IResolvable | TaskProperty)[] (optional)

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

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

---

triggerConfig?

Type: IResolvable | TriggerConfigProperty (optional)

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

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