Class CfnIntegration.FlowDefinitionProperty
The configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CustomerProfiles
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class FlowDefinitionProperty : Object, CfnIntegration.IFlowDefinitionProperty
Syntax (vb)
Public Class FlowDefinitionProperty
Inherits Object
Implements CfnIntegration.IFlowDefinitionProperty
Remarks
Customer Profiles uses this information to create an AppFlow flow on behalf of customers.
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
Constructors
FlowDefinitionProperty() |
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. |
Constructors
FlowDefinitionProperty()
public FlowDefinitionProperty()
Properties
Description
A description of the flow you want to create.
public string Description { get; set; }
Property Value
System.String
Remarks
FlowName
The specified name of the flow.
public string FlowName { get; set; }
Property Value
System.String
Remarks
Use underscores (_) or hyphens (-) only. Spaces are not allowed.
KmsArn
The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key you provide for encryption.
public string KmsArn { get; set; }
Property Value
System.String
Remarks
SourceFlowConfig
The configuration that controls how Customer Profiles retrieves data from the source.
public object SourceFlowConfig { get; set; }
Property Value
System.Object
Remarks
Tasks
A list of tasks that Customer Profiles performs while transferring the data in the flow run.
public object Tasks { get; set; }
Property Value
System.Object
Remarks
TriggerConfig
The trigger settings that determine how and when the flow runs.
public object TriggerConfig { get; set; }
Property Value
System.Object