software.amazon.awscdk.services.customerprofiles

Interface CfnIntegration.FlowDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIntegration.FlowDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnIntegration

@Stability(value=Stable)
public static interface CfnIntegration.FlowDefinitionProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.customerprofiles.*;
 FlowDefinitionProperty flowDefinitionProperty = FlowDefinitionProperty.builder()
         .flowName("flowName")
         .kmsArn("kmsArn")
         .sourceFlowConfig(SourceFlowConfigProperty.builder()
                 .connectorType("connectorType")
                 .sourceConnectorProperties(SourceConnectorPropertiesProperty.builder()
                         .marketo(MarketoSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .s3(S3SourcePropertiesProperty.builder()
                                 .bucketName("bucketName")
                                 // the properties below are optional
                                 .bucketPrefix("bucketPrefix")
                                 .build())
                         .salesforce(SalesforceSourcePropertiesProperty.builder()
                                 .object("object")
                                 // the properties below are optional
                                 .enableDynamicFieldUpdate(false)
                                 .includeDeletedRecords(false)
                                 .build())
                         .serviceNow(ServiceNowSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .zendesk(ZendeskSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .build())
                 // the properties below are optional
                 .connectorProfileName("connectorProfileName")
                 .incrementalPullConfig(IncrementalPullConfigProperty.builder()
                         .datetimeTypeFieldName("datetimeTypeFieldName")
                         .build())
                 .build())
         .tasks(List.of(TaskProperty.builder()
                 .sourceFields(List.of("sourceFields"))
                 .taskType("taskType")
                 // the properties below are optional
                 .connectorOperator(ConnectorOperatorProperty.builder()
                         .marketo("marketo")
                         .s3("s3")
                         .salesforce("salesforce")
                         .serviceNow("serviceNow")
                         .zendesk("zendesk")
                         .build())
                 .destinationField("destinationField")
                 .taskProperties(List.of(TaskPropertiesMapProperty.builder()
                         .operatorPropertyKey("operatorPropertyKey")
                         .property("property")
                         .build()))
                 .build()))
         .triggerConfig(TriggerConfigProperty.builder()
                 .triggerType("triggerType")
                 // the properties below are optional
                 .triggerProperties(TriggerPropertiesProperty.builder()
                         .scheduled(ScheduledTriggerPropertiesProperty.builder()
                                 .scheduleExpression("scheduleExpression")
                                 // the properties below are optional
                                 .dataPullMode("dataPullMode")
                                 .firstExecutionFrom(123)
                                 .scheduleEndTime(123)
                                 .scheduleOffset(123)
                                 .scheduleStartTime(123)
                                 .timezone("timezone")
                                 .build())
                         .build())
                 .build())
         // the properties below are optional
         .description("description")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnIntegration.FlowDefinitionProperty.Builder A builder for CfnIntegration.FlowDefinitionProperty
static class	CfnIntegration.FlowDefinitionProperty.Jsii$Proxy An implementation for CfnIntegration.FlowDefinitionProperty

Method Summary

Modifier and Type	Method and Description
static CfnIntegration.FlowDefinitionProperty.Builder	builder()
default String	getDescription() A description of the flow you want to create.
String	getFlowName() The specified name of the flow.
String	getKmsArn() The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key you provide for encryption.
Object	getSourceFlowConfig() The configuration that controls how Customer Profiles retrieves data from the source.
Object	getTasks() A list of tasks that Customer Profiles performs while transferring the data in the flow run.
Object	getTriggerConfig() The trigger settings that determine how and when the flow runs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFlowName

@Stability(value=Stable)
 @NotNull
String getFlowName()

The specified name of the flow.

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

getKmsArn

@Stability(value=Stable)
 @NotNull
String getKmsArn()

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

getSourceFlowConfig

@Stability(value=Stable)
 @NotNull
Object getSourceFlowConfig()

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

getTasks

@Stability(value=Stable)
 @NotNull
Object getTasks()

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

getTriggerConfig

@Stability(value=Stable)
 @NotNull
Object getTriggerConfig()

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

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A description of the flow you want to create.

builder

@Stability(value=Stable)
static CfnIntegration.FlowDefinitionProperty.Builder builder()

Returns:

a CfnIntegration.FlowDefinitionProperty.Builder of CfnIntegration.FlowDefinitionProperty