Package software.amazon.awscdk.cfnpropertymixins.services.appflow

Class CfnFlowPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.appflow.CfnFlowPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.620Z")
@Stability(Stable)
public class CfnFlowPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::AppFlow::Flow resource is an Amazon AppFlow resource type that specifies a new flow.

If you want to use CloudFormation to create a connector profile for connectors that implement OAuth (such as Salesforce, Slack, Zendesk, and Google Analytics), you must fetch the access and refresh tokens. You can do this by implementing your own UI for OAuth, or by retrieving the tokens from elsewhere. Alternatively, you can use the Amazon AppFlow console to create the connector profile, and then use that connector profile in the flow creation CloudFormation template.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.appflow.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnFlowPropsMixin cfnFlowPropsMixin = CfnFlowPropsMixin.Builder.create(CfnFlowMixinProps.builder()
         .description("description")
         .destinationFlowConfigList(List.of(DestinationFlowConfigProperty.builder()
                 .apiVersion("apiVersion")
                 .connectorProfileName("connectorProfileName")
                 .connectorType("connectorType")
                 .destinationConnectorProperties(DestinationConnectorPropertiesProperty.builder()
                         .customConnector(CustomConnectorDestinationPropertiesProperty.builder()
                                 .customProperties(Map.of(
                                         "customPropertiesKey", "customProperties"))
                                 .entityName("entityName")
                                 .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                         .bucketName("bucketName")
                                         .bucketPrefix("bucketPrefix")
                                         .failOnFirstError(false)
                                         .build())
                                 .idFieldNames(List.of("idFieldNames"))
                                 .writeOperationType("writeOperationType")
                                 .build())
                         .eventBridge(EventBridgeDestinationPropertiesProperty.builder()
                                 .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                         .bucketName("bucketName")
                                         .bucketPrefix("bucketPrefix")
                                         .failOnFirstError(false)
                                         .build())
                                 .object("object")
                                 .build())
                         .lookoutMetrics(LookoutMetricsDestinationPropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .marketo(MarketoDestinationPropertiesProperty.builder()
                                 .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                         .bucketName("bucketName")
                                         .bucketPrefix("bucketPrefix")
                                         .failOnFirstError(false)
                                         .build())
                                 .object("object")
                                 .build())
                         .redshift(RedshiftDestinationPropertiesProperty.builder()
                                 .bucketPrefix("bucketPrefix")
                                 .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                         .bucketName("bucketName")
                                         .bucketPrefix("bucketPrefix")
                                         .failOnFirstError(false)
                                         .build())
                                 .intermediateBucketName("intermediateBucketName")
                                 .object("object")
                                 .build())
                         .s3(S3DestinationPropertiesProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 .s3OutputFormatConfig(S3OutputFormatConfigProperty.builder()
                                         .aggregationConfig(AggregationConfigProperty.builder()
                                                 .aggregationType("aggregationType")
                                                 .targetFileSize(123)
                                                 .build())
                                         .fileType("fileType")
                                         .prefixConfig(PrefixConfigProperty.builder()
                                                 .pathPrefixHierarchy(List.of("pathPrefixHierarchy"))
                                                 .prefixFormat("prefixFormat")
                                                 .prefixType("prefixType")
                                                 .build())
                                         .preserveSourceDataTyping(false)
                                         .build())
                                 .build())
                         .salesforce(SalesforceDestinationPropertiesProperty.builder()
                                 .dataTransferApi("dataTransferApi")
                                 .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                         .bucketName("bucketName")
                                         .bucketPrefix("bucketPrefix")
                                         .failOnFirstError(false)
                                         .build())
                                 .idFieldNames(List.of("idFieldNames"))
                                 .object("object")
                                 .writeOperationType("writeOperationType")
                                 .build())
                         .sapoData(SAPODataDestinationPropertiesProperty.builder()
                                 .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                         .bucketName("bucketName")
                                         .bucketPrefix("bucketPrefix")
                                         .failOnFirstError(false)
                                         .build())
                                 .idFieldNames(List.of("idFieldNames"))
                                 .objectPath("objectPath")
                                 .successResponseHandlingConfig(SuccessResponseHandlingConfigProperty.builder()
                                         .bucketName("bucketName")
                                         .bucketPrefix("bucketPrefix")
                                         .build())
                                 .writeOperationType("writeOperationType")
                                 .build())
                         .snowflake(SnowflakeDestinationPropertiesProperty.builder()
                                 .bucketPrefix("bucketPrefix")
                                 .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                         .bucketName("bucketName")
                                         .bucketPrefix("bucketPrefix")
                                         .failOnFirstError(false)
                                         .build())
                                 .intermediateBucketName("intermediateBucketName")
                                 .object("object")
                                 .build())
                         .upsolver(UpsolverDestinationPropertiesProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 .s3OutputFormatConfig(UpsolverS3OutputFormatConfigProperty.builder()
                                         .aggregationConfig(AggregationConfigProperty.builder()
                                                 .aggregationType("aggregationType")
                                                 .targetFileSize(123)
                                                 .build())
                                         .fileType("fileType")
                                         .prefixConfig(PrefixConfigProperty.builder()
                                                 .pathPrefixHierarchy(List.of("pathPrefixHierarchy"))
                                                 .prefixFormat("prefixFormat")
                                                 .prefixType("prefixType")
                                                 .build())
                                         .build())
                                 .build())
                         .zendesk(ZendeskDestinationPropertiesProperty.builder()
                                 .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                         .bucketName("bucketName")
                                         .bucketPrefix("bucketPrefix")
                                         .failOnFirstError(false)
                                         .build())
                                 .idFieldNames(List.of("idFieldNames"))
                                 .object("object")
                                 .writeOperationType("writeOperationType")
                                 .build())
                         .build())
                 .build()))
         .flowName("flowName")
         .flowStatus("flowStatus")
         .kmsArn("kmsArn")
         .metadataCatalogConfig(MetadataCatalogConfigProperty.builder()
                 .glueDataCatalog(GlueDataCatalogProperty.builder()
                         .databaseName("databaseName")
                         .roleArn("roleArn")
                         .tablePrefix("tablePrefix")
                         .build())
                 .build())
         .sourceFlowConfig(SourceFlowConfigProperty.builder()
                 .apiVersion("apiVersion")
                 .connectorProfileName("connectorProfileName")
                 .connectorType("connectorType")
                 .incrementalPullConfig(IncrementalPullConfigProperty.builder()
                         .datetimeTypeFieldName("datetimeTypeFieldName")
                         .build())
                 .sourceConnectorProperties(SourceConnectorPropertiesProperty.builder()
                         .amplitude(AmplitudeSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .customConnector(CustomConnectorSourcePropertiesProperty.builder()
                                 .customProperties(Map.of(
                                         "customPropertiesKey", "customProperties"))
                                 .dataTransferApi(DataTransferApiProperty.builder()
                                         .name("name")
                                         .type("type")
                                         .build())
                                 .entityName("entityName")
                                 .build())
                         .datadog(DatadogSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .dynatrace(DynatraceSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .googleAnalytics(GoogleAnalyticsSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .inforNexus(InforNexusSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .marketo(MarketoSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .pardot(PardotSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .s3(S3SourcePropertiesProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 .s3InputFormatConfig(S3InputFormatConfigProperty.builder()
                                         .s3InputFileType("s3InputFileType")
                                         .build())
                                 .build())
                         .salesforce(SalesforceSourcePropertiesProperty.builder()
                                 .dataTransferApi("dataTransferApi")
                                 .enableDynamicFieldUpdate(false)
                                 .includeDeletedRecords(false)
                                 .object("object")
                                 .build())
                         .sapoData(SAPODataSourcePropertiesProperty.builder()
                                 .objectPath("objectPath")
                                 .paginationConfig(SAPODataPaginationConfigProperty.builder()
                                         .maxPageSize(123)
                                         .build())
                                 .parallelismConfig(SAPODataParallelismConfigProperty.builder()
                                         .maxParallelism(123)
                                         .build())
                                 .build())
                         .serviceNow(ServiceNowSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .singular(SingularSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .slack(SlackSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .trendmicro(TrendmicroSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .veeva(VeevaSourcePropertiesProperty.builder()
                                 .documentType("documentType")
                                 .includeAllVersions(false)
                                 .includeRenditions(false)
                                 .includeSourceFiles(false)
                                 .object("object")
                                 .build())
                         .zendesk(ZendeskSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tasks(List.of(TaskProperty.builder()
                 .connectorOperator(ConnectorOperatorProperty.builder()
                         .amplitude("amplitude")
                         .customConnector("customConnector")
                         .datadog("datadog")
                         .dynatrace("dynatrace")
                         .googleAnalytics("googleAnalytics")
                         .inforNexus("inforNexus")
                         .marketo("marketo")
                         .pardot("pardot")
                         .s3("s3")
                         .salesforce("salesforce")
                         .sapoData("sapoData")
                         .serviceNow("serviceNow")
                         .singular("singular")
                         .slack("slack")
                         .trendmicro("trendmicro")
                         .veeva("veeva")
                         .zendesk("zendesk")
                         .build())
                 .destinationField("destinationField")
                 .sourceFields(List.of("sourceFields"))
                 .taskProperties(List.of(TaskPropertiesObjectProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .taskType("taskType")
                 .build()))
         .triggerConfig(TriggerConfigProperty.builder()
                 .triggerProperties(ScheduledTriggerPropertiesProperty.builder()
                         .dataPullMode("dataPullMode")
                         .firstExecutionFrom(123)
                         .flowErrorDeactivationThreshold(123)
                         .scheduleEndTime(123)
                         .scheduleExpression("scheduleExpression")
                         .scheduleOffset(123)
                         .scheduleStartTime(123)
                         .timeZone("timeZone")
                         .build())
                 .triggerType("triggerType")
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnFlowPropsMixin.AggregationConfigProperty	The aggregation settings that you can use to customize the output format of your flow data.
static interface	CfnFlowPropsMixin.AmplitudeSourcePropertiesProperty	The properties that are applied when Amplitude is being used as a source.
static final class	CfnFlowPropsMixin.Builder	A fluent builder for CfnFlowPropsMixin.
static interface	CfnFlowPropsMixin.ConnectorOperatorProperty	The operation to be performed on the provided source fields.
static interface	CfnFlowPropsMixin.CustomConnectorDestinationPropertiesProperty	The properties that are applied when the custom connector is being used as a destination.
static interface	CfnFlowPropsMixin.CustomConnectorSourcePropertiesProperty	The properties that are applied when the custom connector is being used as a source.
static interface	CfnFlowPropsMixin.DatadogSourcePropertiesProperty	The properties that are applied when Datadog is being used as a source.
static interface	CfnFlowPropsMixin.DataTransferApiProperty	The API of the connector application that Amazon AppFlow uses to transfer your data.
static interface	CfnFlowPropsMixin.DestinationConnectorPropertiesProperty	This stores the information that is required to query a particular connector.
static interface	CfnFlowPropsMixin.DestinationFlowConfigProperty	Contains information about the configuration of destination connectors present in the flow.
static interface	CfnFlowPropsMixin.DynatraceSourcePropertiesProperty	The properties that are applied when Dynatrace is being used as a source.
static interface	CfnFlowPropsMixin.ErrorHandlingConfigProperty	The settings that determine how Amazon AppFlow handles an error when placing data in the destination.
static interface	CfnFlowPropsMixin.EventBridgeDestinationPropertiesProperty	The properties that are applied when Amazon EventBridge is being used as a destination.
static interface	CfnFlowPropsMixin.GlueDataCatalogProperty	Trigger settings of the flow.
static interface	CfnFlowPropsMixin.GoogleAnalyticsSourcePropertiesProperty	The properties that are applied when Google Analytics is being used as a source.
static interface	CfnFlowPropsMixin.IncrementalPullConfigProperty	Specifies the configuration used when importing incremental records from the source.
static interface	CfnFlowPropsMixin.InforNexusSourcePropertiesProperty	The properties that are applied when Infor Nexus is being used as a source.
static interface	CfnFlowPropsMixin.LookoutMetricsDestinationPropertiesProperty	The properties that are applied when Amazon Lookout for Metrics is used as a destination.
static interface	CfnFlowPropsMixin.MarketoDestinationPropertiesProperty	The properties that Amazon AppFlow applies when you use Marketo as a flow destination.
static interface	CfnFlowPropsMixin.MarketoSourcePropertiesProperty	The properties that are applied when Marketo is being used as a source.
static interface	CfnFlowPropsMixin.MetadataCatalogConfigProperty	Specifies the configuration that Amazon AppFlow uses when it catalogs your data.
static interface	CfnFlowPropsMixin.PardotSourcePropertiesProperty	The properties that are applied when Salesforce Pardot is being used as a source.
static interface	CfnFlowPropsMixin.PrefixConfigProperty	Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination.
static interface	CfnFlowPropsMixin.RedshiftDestinationPropertiesProperty	The properties that are applied when Amazon Redshift is being used as a destination.
static interface	CfnFlowPropsMixin.S3DestinationPropertiesProperty	The properties that are applied when Amazon S3 is used as a destination.
static interface	CfnFlowPropsMixin.S3InputFormatConfigProperty	When you use Amazon S3 as the source, the configuration format that you provide the flow input data.
static interface	CfnFlowPropsMixin.S3OutputFormatConfigProperty	The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.
static interface	CfnFlowPropsMixin.S3SourcePropertiesProperty	The properties that are applied when Amazon S3 is being used as the flow source.
static interface	CfnFlowPropsMixin.SalesforceDestinationPropertiesProperty	The properties that are applied when Salesforce is being used as a destination.
static interface	CfnFlowPropsMixin.SalesforceSourcePropertiesProperty	The properties that are applied when Salesforce is being used as a source.
static interface	CfnFlowPropsMixin.SAPODataDestinationPropertiesProperty	The properties that are applied when using SAPOData as a flow destination.
static interface	CfnFlowPropsMixin.SAPODataPaginationConfigProperty	Sets the page size for each concurrent process that transfers OData records from your SAP instance.
static interface	CfnFlowPropsMixin.SAPODataParallelismConfigProperty	Sets the number of concurrent processes that transfer OData records from your SAP instance.
static interface	CfnFlowPropsMixin.SAPODataSourcePropertiesProperty	The properties that are applied when using SAPOData as a flow source.
static interface	CfnFlowPropsMixin.ScheduledTriggerPropertiesProperty	Specifies the configuration details of a schedule-triggered flow as defined by the user.
static interface	CfnFlowPropsMixin.ServiceNowSourcePropertiesProperty	The properties that are applied when ServiceNow is being used as a source.
static interface	CfnFlowPropsMixin.SingularSourcePropertiesProperty	The properties that are applied when Singular is being used as a source.
static interface	CfnFlowPropsMixin.SlackSourcePropertiesProperty	The properties that are applied when Slack is being used as a source.
static interface	CfnFlowPropsMixin.SnowflakeDestinationPropertiesProperty	The properties that are applied when Snowflake is being used as a destination.
static interface	CfnFlowPropsMixin.SourceConnectorPropertiesProperty	Specifies the information that is required to query a particular connector.
static interface	CfnFlowPropsMixin.SourceFlowConfigProperty	Contains information about the configuration of the source connector used in the flow.
static interface	CfnFlowPropsMixin.SuccessResponseHandlingConfigProperty	Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data.
static interface	CfnFlowPropsMixin.TaskPropertiesObjectProperty	A map used to store task-related information.
static interface	CfnFlowPropsMixin.TaskProperty	A class for modeling different type of tasks.
static interface	CfnFlowPropsMixin.TrendmicroSourcePropertiesProperty	The properties that are applied when using Trend Micro as a flow source.
static interface	CfnFlowPropsMixin.TriggerConfigProperty	The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
static interface	CfnFlowPropsMixin.UpsolverDestinationPropertiesProperty	The properties that are applied when Upsolver is used as a destination.
static interface	CfnFlowPropsMixin.UpsolverS3OutputFormatConfigProperty	The configuration that determines how Amazon AppFlow formats the flow output data when Upsolver is used as the destination.
static interface	CfnFlowPropsMixin.VeevaSourcePropertiesProperty	The properties that are applied when using Veeva as a flow source.
static interface	CfnFlowPropsMixin.ZendeskDestinationPropertiesProperty	The properties that are applied when Zendesk is used as a destination.
static interface	CfnFlowPropsMixin.ZendeskSourcePropertiesProperty	The properties that are applied when using Zendesk as a flow source.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnFlowPropsMixin(CfnFlowMixinProps props)	Create a mixin to apply properties to AWS::AppFlow::Flow.
	CfnFlowPropsMixin(CfnFlowMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::AppFlow::Flow.
protected	CfnFlowPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFlowPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnFlowMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnFlowPropsMixin

protected CfnFlowPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnFlowPropsMixin

protected CfnFlowPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFlowPropsMixin

@Stability(Stable)
public CfnFlowPropsMixin(@NotNull
 CfnFlowMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::AppFlow::Flow.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnFlowPropsMixin

@Stability(Stable)
public CfnFlowPropsMixin(@NotNull
 CfnFlowMixinProps props)

Create a mixin to apply properties to AWS::AppFlow::Flow.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnFlowMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()