CfnFlow L1 construct
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
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appflow as appflow } from 'aws-cdk-lib';
const cfnFlow = new appflow.CfnFlow(this, 'MyCfnFlow', {
destinationFlowConfigList: [{
connectorType: 'connectorType',
destinationConnectorProperties: {
customConnector: {
entityName: 'entityName',
// the properties below are optional
customProperties: {
customPropertiesKey: 'customProperties',
},
errorHandlingConfig: {
bucketName: 'bucketName',
bucketPrefix: 'bucketPrefix',
failOnFirstError: false,
},
idFieldNames: ['idFieldNames'],
writeOperationType: 'writeOperationType',
},
eventBridge: {
object: 'object',
// the properties below are optional
errorHandlingConfig: {
bucketName: 'bucketName',
bucketPrefix: 'bucketPrefix',
failOnFirstError: false,
},
},
lookoutMetrics: {
object: 'object',
},
marketo: {
object: 'object',
// the properties below are optional
errorHandlingConfig: {
bucketName: 'bucketName',
bucketPrefix: 'bucketPrefix',
failOnFirstError: false,
},
},
redshift: {
intermediateBucketName: 'intermediateBucketName',
object: 'object',
// the properties below are optional
bucketPrefix: 'bucketPrefix',
errorHandlingConfig: {
bucketName: 'bucketName',
bucketPrefix: 'bucketPrefix',
failOnFirstError: false,
},
},
s3: {
bucketName: 'bucketName',
// the properties below are optional
bucketPrefix: 'bucketPrefix',
s3OutputFormatConfig: {
aggregationConfig: {
aggregationType: 'aggregationType',
targetFileSize: 123,
},
fileType: 'fileType',
prefixConfig: {
pathPrefixHierarchy: ['pathPrefixHierarchy'],
prefixFormat: 'prefixFormat',
prefixType: 'prefixType',
},
preserveSourceDataTyping: false,
},
},
salesforce: {
object: 'object',
// the properties below are optional
dataTransferApi: 'dataTransferApi',
errorHandlingConfig: {
bucketName: 'bucketName',
bucketPrefix: 'bucketPrefix',
failOnFirstError: false,
},
idFieldNames: ['idFieldNames'],
writeOperationType: 'writeOperationType',
},
sapoData: {
objectPath: 'objectPath',
// the properties below are optional
errorHandlingConfig: {
bucketName: 'bucketName',
bucketPrefix: 'bucketPrefix',
failOnFirstError: false,
},
idFieldNames: ['idFieldNames'],
successResponseHandlingConfig: {
bucketName: 'bucketName',
bucketPrefix: 'bucketPrefix',
},
writeOperationType: 'writeOperationType',
},
snowflake: {
intermediateBucketName: 'intermediateBucketName',
object: 'object',
// the properties below are optional
bucketPrefix: 'bucketPrefix',
errorHandlingConfig: {
bucketName: 'bucketName',
bucketPrefix: 'bucketPrefix',
failOnFirstError: false,
},
},
upsolver: {
bucketName: 'bucketName',
s3OutputFormatConfig: {
prefixConfig: {
pathPrefixHierarchy: ['pathPrefixHierarchy'],
prefixFormat: 'prefixFormat',
prefixType: 'prefixType',
},
// the properties below are optional
aggregationConfig: {
aggregationType: 'aggregationType',
targetFileSize: 123,
},
fileType: 'fileType',
},
// the properties below are optional
bucketPrefix: 'bucketPrefix',
},
zendesk: {
object: 'object',
// the properties below are optional
errorHandlingConfig: {
bucketName: 'bucketName',
bucketPrefix: 'bucketPrefix',
failOnFirstError: false,
},
idFieldNames: ['idFieldNames'],
writeOperationType: 'writeOperationType',
},
},
// the properties below are optional
apiVersion: 'apiVersion',
connectorProfileName: 'connectorProfileName',
}],
flowName: 'flowName',
sourceFlowConfig: {
connectorType: 'connectorType',
sourceConnectorProperties: {
amplitude: {
object: 'object',
},
customConnector: {
entityName: 'entityName',
// the properties below are optional
customProperties: {
customPropertiesKey: 'customProperties',
},
dataTransferApi: {
name: 'name',
type: 'type',
},
},
datadog: {
object: 'object',
},
dynatrace: {
object: 'object',
},
googleAnalytics: {
object: 'object',
},
inforNexus: {
object: 'object',
},
marketo: {
object: 'object',
},
pardot: {
object: 'object',
},
s3: {
bucketName: 'bucketName',
bucketPrefix: 'bucketPrefix',
// the properties below are optional
s3InputFormatConfig: {
s3InputFileType: 's3InputFileType',
},
},
salesforce: {
object: 'object',
// the properties below are optional
dataTransferApi: 'dataTransferApi',
enableDynamicFieldUpdate: false,
includeDeletedRecords: false,
},
sapoData: {
objectPath: 'objectPath',
// the properties below are optional
paginationConfig: {
maxPageSize: 123,
},
parallelismConfig: {
maxParallelism: 123,
},
},
serviceNow: {
object: 'object',
},
singular: {
object: 'object',
},
slack: {
object: 'object',
},
trendmicro: {
object: 'object',
},
veeva: {
object: 'object',
// the properties below are optional
documentType: 'documentType',
includeAllVersions: false,
includeRenditions: false,
includeSourceFiles: false,
},
zendesk: {
object: 'object',
},
},
// the properties below are optional
apiVersion: 'apiVersion',
connectorProfileName: 'connectorProfileName',
incrementalPullConfig: {
datetimeTypeFieldName: 'datetimeTypeFieldName',
},
},
tasks: [{
sourceFields: ['sourceFields'],
taskType: 'taskType',
// the properties below are optional
connectorOperator: {
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',
},
destinationField: 'destinationField',
taskProperties: [{
key: 'key',
value: 'value',
}],
}],
triggerConfig: {
triggerType: 'triggerType',
// the properties below are optional
triggerProperties: {
scheduleExpression: 'scheduleExpression',
// the properties below are optional
dataPullMode: 'dataPullMode',
firstExecutionFrom: 123,
flowErrorDeactivationThreshold: 123,
scheduleEndTime: 123,
scheduleOffset: 123,
scheduleStartTime: 123,
timeZone: 'timeZone',
},
},
// the properties below are optional
description: 'description',
flowStatus: 'flowStatus',
kmsArn: 'kmsArn',
metadataCatalogConfig: {
glueDataCatalog: {
databaseName: 'databaseName',
roleArn: 'roleArn',
tablePrefix: 'tablePrefix',
},
},
tags: [{
key: 'key',
value: 'value',
}],
});
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appflow as appflow
cfn_flow = appflow.CfnFlow(self, "MyCfnFlow",
destination_flow_config_list=[appflow.CfnFlow.DestinationFlowConfigProperty(
connector_type="connectorType",
destination_connector_properties=appflow.CfnFlow.DestinationConnectorPropertiesProperty(
custom_connector=appflow.CfnFlow.CustomConnectorDestinationPropertiesProperty(
entity_name="entityName",
# the properties below are optional
custom_properties={
"custom_properties_key": "customProperties"
},
error_handling_config=appflow.CfnFlow.ErrorHandlingConfigProperty(
bucket_name="bucketName",
bucket_prefix="bucketPrefix",
fail_on_first_error=False
),
id_field_names=["idFieldNames"],
write_operation_type="writeOperationType"
),
event_bridge=appflow.CfnFlow.EventBridgeDestinationPropertiesProperty(
object="object",
# the properties below are optional
error_handling_config=appflow.CfnFlow.ErrorHandlingConfigProperty(
bucket_name="bucketName",
bucket_prefix="bucketPrefix",
fail_on_first_error=False
)
),
lookout_metrics=appflow.CfnFlow.LookoutMetricsDestinationPropertiesProperty(
object="object"
),
marketo=appflow.CfnFlow.MarketoDestinationPropertiesProperty(
object="object",
# the properties below are optional
error_handling_config=appflow.CfnFlow.ErrorHandlingConfigProperty(
bucket_name="bucketName",
bucket_prefix="bucketPrefix",
fail_on_first_error=False
)
),
redshift=appflow.CfnFlow.RedshiftDestinationPropertiesProperty(
intermediate_bucket_name="intermediateBucketName",
object="object",
# the properties below are optional
bucket_prefix="bucketPrefix",
error_handling_config=appflow.CfnFlow.ErrorHandlingConfigProperty(
bucket_name="bucketName",
bucket_prefix="bucketPrefix",
fail_on_first_error=False
)
),
s3=appflow.CfnFlow.S3DestinationPropertiesProperty(
bucket_name="bucketName",
# the properties below are optional
bucket_prefix="bucketPrefix",
s3_output_format_config=appflow.CfnFlow.S3OutputFormatConfigProperty(
aggregation_config=appflow.CfnFlow.AggregationConfigProperty(
aggregation_type="aggregationType",
target_file_size=123
),
file_type="fileType",
prefix_config=appflow.CfnFlow.PrefixConfigProperty(
path_prefix_hierarchy=["pathPrefixHierarchy"],
prefix_format="prefixFormat",
prefix_type="prefixType"
),
preserve_source_data_typing=False
)
),
salesforce=appflow.CfnFlow.SalesforceDestinationPropertiesProperty(
object="object",
# the properties below are optional
data_transfer_api="dataTransferApi",
error_handling_config=appflow.CfnFlow.ErrorHandlingConfigProperty(
bucket_name="bucketName",
bucket_prefix="bucketPrefix",
fail_on_first_error=False
),
id_field_names=["idFieldNames"],
write_operation_type="writeOperationType"
),
sapo_data=appflow.CfnFlow.SAPODataDestinationPropertiesProperty(
object_path="objectPath",
# the properties below are optional
error_handling_config=appflow.CfnFlow.ErrorHandlingConfigProperty(
bucket_name="bucketName",
bucket_prefix="bucketPrefix",
fail_on_first_error=False
),
id_field_names=["idFieldNames"],
success_response_handling_config=appflow.CfnFlow.SuccessResponseHandlingConfigProperty(
bucket_name="bucketName",
bucket_prefix="bucketPrefix"
),
write_operation_type="writeOperationType"
),
snowflake=appflow.CfnFlow.SnowflakeDestinationPropertiesProperty(
intermediate_bucket_name="intermediateBucketName",
object="object",
# the properties below are optional
bucket_prefix="bucketPrefix",
error_handling_config=appflow.CfnFlow.ErrorHandlingConfigProperty(
bucket_name="bucketName",
bucket_prefix="bucketPrefix",
fail_on_first_error=False
)
),
upsolver=appflow.CfnFlow.UpsolverDestinationPropertiesProperty(
bucket_name="bucketName",
s3_output_format_config=appflow.CfnFlow.UpsolverS3OutputFormatConfigProperty(
prefix_config=appflow.CfnFlow.PrefixConfigProperty(
path_prefix_hierarchy=["pathPrefixHierarchy"],
prefix_format="prefixFormat",
prefix_type="prefixType"
),
# the properties below are optional
aggregation_config=appflow.CfnFlow.AggregationConfigProperty(
aggregation_type="aggregationType",
target_file_size=123
),
file_type="fileType"
),
# the properties below are optional
bucket_prefix="bucketPrefix"
),
zendesk=appflow.CfnFlow.ZendeskDestinationPropertiesProperty(
object="object",
# the properties below are optional
error_handling_config=appflow.CfnFlow.ErrorHandlingConfigProperty(
bucket_name="bucketName",
bucket_prefix="bucketPrefix",
fail_on_first_error=False
),
id_field_names=["idFieldNames"],
write_operation_type="writeOperationType"
)
),
# the properties below are optional
api_version="apiVersion",
connector_profile_name="connectorProfileName"
)],
flow_name="flowName",
source_flow_config=appflow.CfnFlow.SourceFlowConfigProperty(
connector_type="connectorType",
source_connector_properties=appflow.CfnFlow.SourceConnectorPropertiesProperty(
amplitude=appflow.CfnFlow.AmplitudeSourcePropertiesProperty(
object="object"
),
custom_connector=appflow.CfnFlow.CustomConnectorSourcePropertiesProperty(
entity_name="entityName",
# the properties below are optional
custom_properties={
"custom_properties_key": "customProperties"
},
data_transfer_api=appflow.CfnFlow.DataTransferApiProperty(
name="name",
type="type"
)
),
datadog=appflow.CfnFlow.DatadogSourcePropertiesProperty(
object="object"
),
dynatrace=appflow.CfnFlow.DynatraceSourcePropertiesProperty(
object="object"
),
google_analytics=appflow.CfnFlow.GoogleAnalyticsSourcePropertiesProperty(
object="object"
),
infor_nexus=appflow.CfnFlow.InforNexusSourcePropertiesProperty(
object="object"
),
marketo=appflow.CfnFlow.MarketoSourcePropertiesProperty(
object="object"
),
pardot=appflow.CfnFlow.PardotSourcePropertiesProperty(
object="object"
),
s3=appflow.CfnFlow.S3SourcePropertiesProperty(
bucket_name="bucketName",
bucket_prefix="bucketPrefix",
# the properties below are optional
s3_input_format_config=appflow.CfnFlow.S3InputFormatConfigProperty(
s3_input_file_type="s3InputFileType"
)
),
salesforce=appflow.CfnFlow.SalesforceSourcePropertiesProperty(
object="object",
# the properties below are optional
data_transfer_api="dataTransferApi",
enable_dynamic_field_update=False,
include_deleted_records=False
),
sapo_data=appflow.CfnFlow.SAPODataSourcePropertiesProperty(
object_path="objectPath",
# the properties below are optional
pagination_config=appflow.CfnFlow.SAPODataPaginationConfigProperty(
max_page_size=123
),
parallelism_config=appflow.CfnFlow.SAPODataParallelismConfigProperty(
max_parallelism=123
)
),
service_now=appflow.CfnFlow.ServiceNowSourcePropertiesProperty(
object="object"
),
singular=appflow.CfnFlow.SingularSourcePropertiesProperty(
object="object"
),
slack=appflow.CfnFlow.SlackSourcePropertiesProperty(
object="object"
),
trendmicro=appflow.CfnFlow.TrendmicroSourcePropertiesProperty(
object="object"
),
veeva=appflow.CfnFlow.VeevaSourcePropertiesProperty(
object="object",
# the properties below are optional
document_type="documentType",
include_all_versions=False,
include_renditions=False,
include_source_files=False
),
zendesk=appflow.CfnFlow.ZendeskSourcePropertiesProperty(
object="object"
)
),
# the properties below are optional
api_version="apiVersion",
connector_profile_name="connectorProfileName",
incremental_pull_config=appflow.CfnFlow.IncrementalPullConfigProperty(
datetime_type_field_name="datetimeTypeFieldName"
)
),
tasks=[appflow.CfnFlow.TaskProperty(
source_fields=["sourceFields"],
task_type="taskType",
# the properties below are optional
connector_operator=appflow.CfnFlow.ConnectorOperatorProperty(
amplitude="amplitude",
custom_connector="customConnector",
datadog="datadog",
dynatrace="dynatrace",
google_analytics="googleAnalytics",
infor_nexus="inforNexus",
marketo="marketo",
pardot="pardot",
s3="s3",
salesforce="salesforce",
sapo_data="sapoData",
service_now="serviceNow",
singular="singular",
slack="slack",
trendmicro="trendmicro",
veeva="veeva",
zendesk="zendesk"
),
destination_field="destinationField",
task_properties=[appflow.CfnFlow.TaskPropertiesObjectProperty(
key="key",
value="value"
)]
)],
trigger_config=appflow.CfnFlow.TriggerConfigProperty(
trigger_type="triggerType",
# the properties below are optional
trigger_properties=appflow.CfnFlow.ScheduledTriggerPropertiesProperty(
schedule_expression="scheduleExpression",
# the properties below are optional
data_pull_mode="dataPullMode",
first_execution_from=123,
flow_error_deactivation_threshold=123,
schedule_end_time=123,
schedule_offset=123,
schedule_start_time=123,
time_zone="timeZone"
)
),
# the properties below are optional
description="description",
flow_status="flowStatus",
kms_arn="kmsArn",
metadata_catalog_config=appflow.CfnFlow.MetadataCatalogConfigProperty(
glue_data_catalog=appflow.CfnFlow.GlueDataCatalogProperty(
database_name="databaseName",
role_arn="roleArn",
table_prefix="tablePrefix"
)
),
tags=[CfnTag(
key="key",
value="value"
)]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.appflow.*;
CfnFlow cfnFlow = CfnFlow.Builder.create(this, "MyCfnFlow")
.destinationFlowConfigList(List.of(DestinationFlowConfigProperty.builder()
.connectorType("connectorType")
.destinationConnectorProperties(DestinationConnectorPropertiesProperty.builder()
.customConnector(CustomConnectorDestinationPropertiesProperty.builder()
.entityName("entityName")
// the properties below are optional
.customProperties(Map.of(
"customPropertiesKey", "customProperties"))
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.idFieldNames(List.of("idFieldNames"))
.writeOperationType("writeOperationType")
.build())
.eventBridge(EventBridgeDestinationPropertiesProperty.builder()
.object("object")
// the properties below are optional
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.build())
.lookoutMetrics(LookoutMetricsDestinationPropertiesProperty.builder()
.object("object")
.build())
.marketo(MarketoDestinationPropertiesProperty.builder()
.object("object")
// the properties below are optional
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.build())
.redshift(RedshiftDestinationPropertiesProperty.builder()
.intermediateBucketName("intermediateBucketName")
.object("object")
// the properties below are optional
.bucketPrefix("bucketPrefix")
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.build())
.s3(S3DestinationPropertiesProperty.builder()
.bucketName("bucketName")
// the properties below are optional
.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()
.object("object")
// the properties below are optional
.dataTransferApi("dataTransferApi")
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.idFieldNames(List.of("idFieldNames"))
.writeOperationType("writeOperationType")
.build())
.sapoData(SAPODataDestinationPropertiesProperty.builder()
.objectPath("objectPath")
// the properties below are optional
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.idFieldNames(List.of("idFieldNames"))
.successResponseHandlingConfig(SuccessResponseHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.build())
.writeOperationType("writeOperationType")
.build())
.snowflake(SnowflakeDestinationPropertiesProperty.builder()
.intermediateBucketName("intermediateBucketName")
.object("object")
// the properties below are optional
.bucketPrefix("bucketPrefix")
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.build())
.upsolver(UpsolverDestinationPropertiesProperty.builder()
.bucketName("bucketName")
.s3OutputFormatConfig(UpsolverS3OutputFormatConfigProperty.builder()
.prefixConfig(PrefixConfigProperty.builder()
.pathPrefixHierarchy(List.of("pathPrefixHierarchy"))
.prefixFormat("prefixFormat")
.prefixType("prefixType")
.build())
// the properties below are optional
.aggregationConfig(AggregationConfigProperty.builder()
.aggregationType("aggregationType")
.targetFileSize(123)
.build())
.fileType("fileType")
.build())
// the properties below are optional
.bucketPrefix("bucketPrefix")
.build())
.zendesk(ZendeskDestinationPropertiesProperty.builder()
.object("object")
// the properties below are optional
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.idFieldNames(List.of("idFieldNames"))
.writeOperationType("writeOperationType")
.build())
.build())
// the properties below are optional
.apiVersion("apiVersion")
.connectorProfileName("connectorProfileName")
.build()))
.flowName("flowName")
.sourceFlowConfig(SourceFlowConfigProperty.builder()
.connectorType("connectorType")
.sourceConnectorProperties(SourceConnectorPropertiesProperty.builder()
.amplitude(AmplitudeSourcePropertiesProperty.builder()
.object("object")
.build())
.customConnector(CustomConnectorSourcePropertiesProperty.builder()
.entityName("entityName")
// the properties below are optional
.customProperties(Map.of(
"customPropertiesKey", "customProperties"))
.dataTransferApi(DataTransferApiProperty.builder()
.name("name")
.type("type")
.build())
.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")
// the properties below are optional
.s3InputFormatConfig(S3InputFormatConfigProperty.builder()
.s3InputFileType("s3InputFileType")
.build())
.build())
.salesforce(SalesforceSourcePropertiesProperty.builder()
.object("object")
// the properties below are optional
.dataTransferApi("dataTransferApi")
.enableDynamicFieldUpdate(false)
.includeDeletedRecords(false)
.build())
.sapoData(SAPODataSourcePropertiesProperty.builder()
.objectPath("objectPath")
// the properties below are optional
.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()
.object("object")
// the properties below are optional
.documentType("documentType")
.includeAllVersions(false)
.includeRenditions(false)
.includeSourceFiles(false)
.build())
.zendesk(ZendeskSourcePropertiesProperty.builder()
.object("object")
.build())
.build())
// the properties below are optional
.apiVersion("apiVersion")
.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()
.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")
.taskProperties(List.of(TaskPropertiesObjectProperty.builder()
.key("key")
.value("value")
.build()))
.build()))
.triggerConfig(TriggerConfigProperty.builder()
.triggerType("triggerType")
// the properties below are optional
.triggerProperties(ScheduledTriggerPropertiesProperty.builder()
.scheduleExpression("scheduleExpression")
// the properties below are optional
.dataPullMode("dataPullMode")
.firstExecutionFrom(123)
.flowErrorDeactivationThreshold(123)
.scheduleEndTime(123)
.scheduleOffset(123)
.scheduleStartTime(123)
.timeZone("timeZone")
.build())
.build())
// the properties below are optional
.description("description")
.flowStatus("flowStatus")
.kmsArn("kmsArn")
.metadataCatalogConfig(MetadataCatalogConfigProperty.builder()
.glueDataCatalog(GlueDataCatalogProperty.builder()
.databaseName("databaseName")
.roleArn("roleArn")
.tablePrefix("tablePrefix")
.build())
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppFlow;
var cfnFlow = new CfnFlow(this, "MyCfnFlow", new CfnFlowProps {
DestinationFlowConfigList = new [] { new DestinationFlowConfigProperty {
ConnectorType = "connectorType",
DestinationConnectorProperties = new DestinationConnectorPropertiesProperty {
CustomConnector = new CustomConnectorDestinationPropertiesProperty {
EntityName = "entityName",
// the properties below are optional
CustomProperties = new Dictionary<string, string> {
{ "customPropertiesKey", "customProperties" }
},
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
},
IdFieldNames = new [] { "idFieldNames" },
WriteOperationType = "writeOperationType"
},
EventBridge = new EventBridgeDestinationPropertiesProperty {
Object = "object",
// the properties below are optional
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
}
},
LookoutMetrics = new LookoutMetricsDestinationPropertiesProperty {
Object = "object"
},
Marketo = new MarketoDestinationPropertiesProperty {
Object = "object",
// the properties below are optional
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
}
},
Redshift = new RedshiftDestinationPropertiesProperty {
IntermediateBucketName = "intermediateBucketName",
Object = "object",
// the properties below are optional
BucketPrefix = "bucketPrefix",
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
}
},
S3 = new S3DestinationPropertiesProperty {
BucketName = "bucketName",
// the properties below are optional
BucketPrefix = "bucketPrefix",
S3OutputFormatConfig = new S3OutputFormatConfigProperty {
AggregationConfig = new AggregationConfigProperty {
AggregationType = "aggregationType",
TargetFileSize = 123
},
FileType = "fileType",
PrefixConfig = new PrefixConfigProperty {
PathPrefixHierarchy = new [] { "pathPrefixHierarchy" },
PrefixFormat = "prefixFormat",
PrefixType = "prefixType"
},
PreserveSourceDataTyping = false
}
},
Salesforce = new SalesforceDestinationPropertiesProperty {
Object = "object",
// the properties below are optional
DataTransferApi = "dataTransferApi",
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
},
IdFieldNames = new [] { "idFieldNames" },
WriteOperationType = "writeOperationType"
},
SapoData = new SAPODataDestinationPropertiesProperty {
ObjectPath = "objectPath",
// the properties below are optional
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
},
IdFieldNames = new [] { "idFieldNames" },
SuccessResponseHandlingConfig = new SuccessResponseHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix"
},
WriteOperationType = "writeOperationType"
},
Snowflake = new SnowflakeDestinationPropertiesProperty {
IntermediateBucketName = "intermediateBucketName",
Object = "object",
// the properties below are optional
BucketPrefix = "bucketPrefix",
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
}
},
Upsolver = new UpsolverDestinationPropertiesProperty {
BucketName = "bucketName",
S3OutputFormatConfig = new UpsolverS3OutputFormatConfigProperty {
PrefixConfig = new PrefixConfigProperty {
PathPrefixHierarchy = new [] { "pathPrefixHierarchy" },
PrefixFormat = "prefixFormat",
PrefixType = "prefixType"
},
// the properties below are optional
AggregationConfig = new AggregationConfigProperty {
AggregationType = "aggregationType",
TargetFileSize = 123
},
FileType = "fileType"
},
// the properties below are optional
BucketPrefix = "bucketPrefix"
},
Zendesk = new ZendeskDestinationPropertiesProperty {
Object = "object",
// the properties below are optional
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
},
IdFieldNames = new [] { "idFieldNames" },
WriteOperationType = "writeOperationType"
}
},
// the properties below are optional
ApiVersion = "apiVersion",
ConnectorProfileName = "connectorProfileName"
} },
FlowName = "flowName",
SourceFlowConfig = new SourceFlowConfigProperty {
ConnectorType = "connectorType",
SourceConnectorProperties = new SourceConnectorPropertiesProperty {
Amplitude = new AmplitudeSourcePropertiesProperty {
Object = "object"
},
CustomConnector = new CustomConnectorSourcePropertiesProperty {
EntityName = "entityName",
// the properties below are optional
CustomProperties = new Dictionary<string, string> {
{ "customPropertiesKey", "customProperties" }
},
DataTransferApi = new DataTransferApiProperty {
Name = "name",
Type = "type"
}
},
Datadog = new DatadogSourcePropertiesProperty {
Object = "object"
},
Dynatrace = new DynatraceSourcePropertiesProperty {
Object = "object"
},
GoogleAnalytics = new GoogleAnalyticsSourcePropertiesProperty {
Object = "object"
},
InforNexus = new InforNexusSourcePropertiesProperty {
Object = "object"
},
Marketo = new MarketoSourcePropertiesProperty {
Object = "object"
},
Pardot = new PardotSourcePropertiesProperty {
Object = "object"
},
S3 = new S3SourcePropertiesProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
// the properties below are optional
S3InputFormatConfig = new S3InputFormatConfigProperty {
S3InputFileType = "s3InputFileType"
}
},
Salesforce = new SalesforceSourcePropertiesProperty {
Object = "object",
// the properties below are optional
DataTransferApi = "dataTransferApi",
EnableDynamicFieldUpdate = false,
IncludeDeletedRecords = false
},
SapoData = new SAPODataSourcePropertiesProperty {
ObjectPath = "objectPath",
// the properties below are optional
PaginationConfig = new SAPODataPaginationConfigProperty {
MaxPageSize = 123
},
ParallelismConfig = new SAPODataParallelismConfigProperty {
MaxParallelism = 123
}
},
ServiceNow = new ServiceNowSourcePropertiesProperty {
Object = "object"
},
Singular = new SingularSourcePropertiesProperty {
Object = "object"
},
Slack = new SlackSourcePropertiesProperty {
Object = "object"
},
Trendmicro = new TrendmicroSourcePropertiesProperty {
Object = "object"
},
Veeva = new VeevaSourcePropertiesProperty {
Object = "object",
// the properties below are optional
DocumentType = "documentType",
IncludeAllVersions = false,
IncludeRenditions = false,
IncludeSourceFiles = false
},
Zendesk = new ZendeskSourcePropertiesProperty {
Object = "object"
}
},
// the properties below are optional
ApiVersion = "apiVersion",
ConnectorProfileName = "connectorProfileName",
IncrementalPullConfig = new IncrementalPullConfigProperty {
DatetimeTypeFieldName = "datetimeTypeFieldName"
}
},
Tasks = new [] { new TaskProperty {
SourceFields = new [] { "sourceFields" },
TaskType = "taskType",
// the properties below are optional
ConnectorOperator = new ConnectorOperatorProperty {
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"
},
DestinationField = "destinationField",
TaskProperties = new [] { new TaskPropertiesObjectProperty {
Key = "key",
Value = "value"
} }
} },
TriggerConfig = new TriggerConfigProperty {
TriggerType = "triggerType",
// the properties below are optional
TriggerProperties = new ScheduledTriggerPropertiesProperty {
ScheduleExpression = "scheduleExpression",
// the properties below are optional
DataPullMode = "dataPullMode",
FirstExecutionFrom = 123,
FlowErrorDeactivationThreshold = 123,
ScheduleEndTime = 123,
ScheduleOffset = 123,
ScheduleStartTime = 123,
TimeZone = "timeZone"
}
},
// the properties below are optional
Description = "description",
FlowStatus = "flowStatus",
KmsArn = "kmsArn",
MetadataCatalogConfig = new MetadataCatalogConfigProperty {
GlueDataCatalog = new GlueDataCatalogProperty {
DatabaseName = "databaseName",
RoleArn = "roleArn",
TablePrefix = "tablePrefix"
}
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnFlow := awscdk.Aws_appflow.NewCfnFlow(this, jsii.String("MyCfnFlow"), &CfnFlowProps{
DestinationFlowConfigList: []interface{}{
&DestinationFlowConfigProperty{
ConnectorType: jsii.String("connectorType"),
DestinationConnectorProperties: &DestinationConnectorPropertiesProperty{
CustomConnector: &CustomConnectorDestinationPropertiesProperty{
EntityName: jsii.String("entityName"),
// the properties below are optional
CustomProperties: map[string]*string{
"customPropertiesKey": jsii.String("customProperties"),
},
ErrorHandlingConfig: &ErrorHandlingConfigProperty{
BucketName: jsii.String("bucketName"),
BucketPrefix: jsii.String("bucketPrefix"),
FailOnFirstError: jsii.Boolean(false),
},
IdFieldNames: []*string{
jsii.String("idFieldNames"),
},
WriteOperationType: jsii.String("writeOperationType"),
},
EventBridge: &EventBridgeDestinationPropertiesProperty{
Object: jsii.String("object"),
// the properties below are optional
ErrorHandlingConfig: &ErrorHandlingConfigProperty{
BucketName: jsii.String("bucketName"),
BucketPrefix: jsii.String("bucketPrefix"),
FailOnFirstError: jsii.Boolean(false),
},
},
LookoutMetrics: &LookoutMetricsDestinationPropertiesProperty{
Object: jsii.String("object"),
},
Marketo: &MarketoDestinationPropertiesProperty{
Object: jsii.String("object"),
// the properties below are optional
ErrorHandlingConfig: &ErrorHandlingConfigProperty{
BucketName: jsii.String("bucketName"),
BucketPrefix: jsii.String("bucketPrefix"),
FailOnFirstError: jsii.Boolean(false),
},
},
Redshift: &RedshiftDestinationPropertiesProperty{
IntermediateBucketName: jsii.String("intermediateBucketName"),
Object: jsii.String("object"),
// the properties below are optional
BucketPrefix: jsii.String("bucketPrefix"),
ErrorHandlingConfig: &ErrorHandlingConfigProperty{
BucketName: jsii.String("bucketName"),
BucketPrefix: jsii.String("bucketPrefix"),
FailOnFirstError: jsii.Boolean(false),
},
},
S3: &S3DestinationPropertiesProperty{
BucketName: jsii.String("bucketName"),
// the properties below are optional
BucketPrefix: jsii.String("bucketPrefix"),
S3OutputFormatConfig: &S3OutputFormatConfigProperty{
AggregationConfig: &AggregationConfigProperty{
AggregationType: jsii.String("aggregationType"),
TargetFileSize: jsii.Number(123),
},
FileType: jsii.String("fileType"),
PrefixConfig: &PrefixConfigProperty{
PathPrefixHierarchy: []*string{
jsii.String("pathPrefixHierarchy"),
},
PrefixFormat: jsii.String("prefixFormat"),
PrefixType: jsii.String("prefixType"),
},
PreserveSourceDataTyping: jsii.Boolean(false),
},
},
Salesforce: &SalesforceDestinationPropertiesProperty{
Object: jsii.String("object"),
// the properties below are optional
DataTransferApi: jsii.String("dataTransferApi"),
ErrorHandlingConfig: &ErrorHandlingConfigProperty{
BucketName: jsii.String("bucketName"),
BucketPrefix: jsii.String("bucketPrefix"),
FailOnFirstError: jsii.Boolean(false),
},
IdFieldNames: []*string{
jsii.String("idFieldNames"),
},
WriteOperationType: jsii.String("writeOperationType"),
},
SapoData: &SAPODataDestinationPropertiesProperty{
ObjectPath: jsii.String("objectPath"),
// the properties below are optional
ErrorHandlingConfig: &ErrorHandlingConfigProperty{
BucketName: jsii.String("bucketName"),
BucketPrefix: jsii.String("bucketPrefix"),
FailOnFirstError: jsii.Boolean(false),
},
IdFieldNames: []*string{
jsii.String("idFieldNames"),
},
SuccessResponseHandlingConfig: &SuccessResponseHandlingConfigProperty{
BucketName: jsii.String("bucketName"),
BucketPrefix: jsii.String("bucketPrefix"),
},
WriteOperationType: jsii.String("writeOperationType"),
},
Snowflake: &SnowflakeDestinationPropertiesProperty{
IntermediateBucketName: jsii.String("intermediateBucketName"),
Object: jsii.String("object"),
// the properties below are optional
BucketPrefix: jsii.String("bucketPrefix"),
ErrorHandlingConfig: &ErrorHandlingConfigProperty{
BucketName: jsii.String("bucketName"),
BucketPrefix: jsii.String("bucketPrefix"),
FailOnFirstError: jsii.Boolean(false),
},
},
Upsolver: &UpsolverDestinationPropertiesProperty{
BucketName: jsii.String("bucketName"),
S3OutputFormatConfig: &UpsolverS3OutputFormatConfigProperty{
PrefixConfig: &PrefixConfigProperty{
PathPrefixHierarchy: []*string{
jsii.String("pathPrefixHierarchy"),
},
PrefixFormat: jsii.String("prefixFormat"),
PrefixType: jsii.String("prefixType"),
},
// the properties below are optional
AggregationConfig: &AggregationConfigProperty{
AggregationType: jsii.String("aggregationType"),
TargetFileSize: jsii.Number(123),
},
FileType: jsii.String("fileType"),
},
// the properties below are optional
BucketPrefix: jsii.String("bucketPrefix"),
},
Zendesk: &ZendeskDestinationPropertiesProperty{
Object: jsii.String("object"),
// the properties below are optional
ErrorHandlingConfig: &ErrorHandlingConfigProperty{
BucketName: jsii.String("bucketName"),
BucketPrefix: jsii.String("bucketPrefix"),
FailOnFirstError: jsii.Boolean(false),
},
IdFieldNames: []*string{
jsii.String("idFieldNames"),
},
WriteOperationType: jsii.String("writeOperationType"),
},
},
// the properties below are optional
ApiVersion: jsii.String("apiVersion"),
ConnectorProfileName: jsii.String("connectorProfileName"),
},
},
FlowName: jsii.String("flowName"),
SourceFlowConfig: &SourceFlowConfigProperty{
ConnectorType: jsii.String("connectorType"),
SourceConnectorProperties: &SourceConnectorPropertiesProperty{
Amplitude: &AmplitudeSourcePropertiesProperty{
Object: jsii.String("object"),
},
CustomConnector: &CustomConnectorSourcePropertiesProperty{
EntityName: jsii.String("entityName"),
// the properties below are optional
CustomProperties: map[string]*string{
"customPropertiesKey": jsii.String("customProperties"),
},
DataTransferApi: &DataTransferApiProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
},
},
Datadog: &DatadogSourcePropertiesProperty{
Object: jsii.String("object"),
},
Dynatrace: &DynatraceSourcePropertiesProperty{
Object: jsii.String("object"),
},
GoogleAnalytics: &GoogleAnalyticsSourcePropertiesProperty{
Object: jsii.String("object"),
},
InforNexus: &InforNexusSourcePropertiesProperty{
Object: jsii.String("object"),
},
Marketo: &MarketoSourcePropertiesProperty{
Object: jsii.String("object"),
},
Pardot: &PardotSourcePropertiesProperty{
Object: jsii.String("object"),
},
S3: &S3SourcePropertiesProperty{
BucketName: jsii.String("bucketName"),
BucketPrefix: jsii.String("bucketPrefix"),
// the properties below are optional
S3InputFormatConfig: &S3InputFormatConfigProperty{
S3InputFileType: jsii.String("s3InputFileType"),
},
},
Salesforce: &SalesforceSourcePropertiesProperty{
Object: jsii.String("object"),
// the properties below are optional
DataTransferApi: jsii.String("dataTransferApi"),
EnableDynamicFieldUpdate: jsii.Boolean(false),
IncludeDeletedRecords: jsii.Boolean(false),
},
SapoData: &SAPODataSourcePropertiesProperty{
ObjectPath: jsii.String("objectPath"),
// the properties below are optional
PaginationConfig: &SAPODataPaginationConfigProperty{
MaxPageSize: jsii.Number(123),
},
ParallelismConfig: &SAPODataParallelismConfigProperty{
MaxParallelism: jsii.Number(123),
},
},
ServiceNow: &ServiceNowSourcePropertiesProperty{
Object: jsii.String("object"),
},
Singular: &SingularSourcePropertiesProperty{
Object: jsii.String("object"),
},
Slack: &SlackSourcePropertiesProperty{
Object: jsii.String("object"),
},
Trendmicro: &TrendmicroSourcePropertiesProperty{
Object: jsii.String("object"),
},
Veeva: &VeevaSourcePropertiesProperty{
Object: jsii.String("object"),
// the properties below are optional
DocumentType: jsii.String("documentType"),
IncludeAllVersions: jsii.Boolean(false),
IncludeRenditions: jsii.Boolean(false),
IncludeSourceFiles: jsii.Boolean(false),
},
Zendesk: &ZendeskSourcePropertiesProperty{
Object: jsii.String("object"),
},
},
// the properties below are optional
ApiVersion: jsii.String("apiVersion"),
ConnectorProfileName: jsii.String("connectorProfileName"),
IncrementalPullConfig: &IncrementalPullConfigProperty{
DatetimeTypeFieldName: jsii.String("datetimeTypeFieldName"),
},
},
Tasks: []interface{}{
&TaskProperty{
SourceFields: []*string{
jsii.String("sourceFields"),
},
TaskType: jsii.String("taskType"),
// the properties below are optional
ConnectorOperator: &ConnectorOperatorProperty{
Amplitude: jsii.String("amplitude"),
CustomConnector: jsii.String("customConnector"),
Datadog: jsii.String("datadog"),
Dynatrace: jsii.String("dynatrace"),
GoogleAnalytics: jsii.String("googleAnalytics"),
InforNexus: jsii.String("inforNexus"),
Marketo: jsii.String("marketo"),
Pardot: jsii.String("pardot"),
S3: jsii.String("s3"),
Salesforce: jsii.String("salesforce"),
SapoData: jsii.String("sapoData"),
ServiceNow: jsii.String("serviceNow"),
Singular: jsii.String("singular"),
Slack: jsii.String("slack"),
Trendmicro: jsii.String("trendmicro"),
Veeva: jsii.String("veeva"),
Zendesk: jsii.String("zendesk"),
},
DestinationField: jsii.String("destinationField"),
TaskProperties: []interface{}{
&TaskPropertiesObjectProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
TriggerConfig: &TriggerConfigProperty{
TriggerType: jsii.String("triggerType"),
// the properties below are optional
TriggerProperties: &ScheduledTriggerPropertiesProperty{
ScheduleExpression: jsii.String("scheduleExpression"),
// the properties below are optional
DataPullMode: jsii.String("dataPullMode"),
FirstExecutionFrom: jsii.Number(123),
FlowErrorDeactivationThreshold: jsii.Number(123),
ScheduleEndTime: jsii.Number(123),
ScheduleOffset: jsii.Number(123),
ScheduleStartTime: jsii.Number(123),
TimeZone: jsii.String("timeZone"),
},
},
// the properties below are optional
Description: jsii.String("description"),
FlowStatus: jsii.String("flowStatus"),
KmsArn: jsii.String("kmsArn"),
MetadataCatalogConfig: &MetadataCatalogConfigProperty{
GlueDataCatalog: &GlueDataCatalogProperty{
DatabaseName: jsii.String("databaseName"),
RoleArn: jsii.String("roleArn"),
TablePrefix: jsii.String("tablePrefix"),
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
Initializer
ts
new CfnFlow(scope: Construct, id: string, props: CfnFlowProps)
python
CfnFlow(scope: Construct, id: str, props: CfnFlowProps)
java
new CfnFlow(Construct scope, String id, CfnFlowProps props)
csharp
new CfnFlow(Construct scope, string id, CfnFlowProps props)
go
NewCfnFlow(Scope Construct, Id *string, Props CfnFlowProps)
Construct Props
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A user-entered description of the flow.
destinationFlowConfigListIResolvable | IResolvable | CfnFlow.DestinationFlowConfigProperty[]destination_flow_config_listtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DestinationFlowConfigProperty]]]destinationFlowConfigListIResolvableDestinationFlowConfigListIResolvableDestinationFlowConfigListinterface{}required#The configuration that controls how Amazon AppFlow places data in the destination connector.
The specified name of the flow.
Spaces are not allowed. Use underscores (_) or hyphens (-) only.
flowStatusoptionalstringflow_statusoptionalstrflowStatusoptionalStringFlowStatusoptionalstringFlowStatusoptional*string#Sets the status of the flow. You can specify one of the following values:.
notes
- Active - The flow runs based on the trigger settings that you defined. Active scheduled flows run as scheduled, and active event-triggered flows run when the specified change event occurs. However, active on-demand flows run only when you manually start them by using Amazon AppFlow.
- Suspended - You can use this option to deactivate an active flow. Scheduled and event-triggered flows will cease to run until you reactive them. This value only affects scheduled and event-triggered flows. It has no effect for on-demand flows.
If you omit the FlowStatus parameter, Amazon AppFlow creates the flow with a default status. The default status for on-demand flows is Active. The default status for scheduled and event-triggered flows is Draft, which means they’re not yet active.
kmsArnoptionalstring | IKeyRefkms_arnoptionaltyping.Union[str, IKeyRef]kmsArnoptionalStringKmsArnoptionalstringKmsArnoptionalinterface{}#The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
metadataCatalogConfigoptionalIResolvable | CfnFlow.MetadataCatalogConfigPropertymetadata_catalog_configoptionaltyping.Union[IResolvable, MetadataCatalogConfigProperty]metadataCatalogConfigoptionalIResolvableMetadataCatalogConfigoptionalIResolvableMetadataCatalogConfigoptionalinterface{}#Specifies the configuration that Amazon AppFlow uses when it catalogs your data.
When Amazon AppFlow catalogs your data, it stores metadata in a data catalog.
sourceFlowConfigIResolvable | CfnFlow.SourceFlowConfigPropertysource_flow_configtyping.Union[IResolvable, SourceFlowConfigProperty]sourceFlowConfigIResolvableSourceFlowConfigIResolvableSourceFlowConfiginterface{}required#Contains information about the configuration of the source connector used in the flow.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#The tags used to organize, track, or control access for your flow.
tasksIResolvable | IResolvable | CfnFlow.TaskProperty[]taskstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TaskProperty]]]tasksIResolvableTasksIResolvableTasksinterface{}required#A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
triggerConfigIResolvable | CfnFlow.TriggerConfigPropertytrigger_configtyping.Union[IResolvable, TriggerConfigProperty]triggerConfigIResolvableTriggerConfigIResolvableTriggerConfiginterface{}required#The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
Properties
The flow's Amazon Resource Name (ARN).
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#AWS resource type.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#A user-entered description of the flow.
destinationFlowConfigListIResolvable | IResolvable | CfnFlow.DestinationFlowConfigProperty[]destination_flow_config_listtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DestinationFlowConfigProperty]]]destinationFlowConfigListIResolvableDestinationFlowConfigListIResolvableDestinationFlowConfigListinterface{}#The configuration that controls how Amazon AppFlow places data in the destination connector.
The specified name of the flow.
flowRefFlowReferenceflow_refFlowReferenceflowRefFlowReferenceFlowRefFlowReferenceFlowRefFlowReference#A reference to a Flow resource.
flowStatusmay be undefinedstringflow_statusmay be undefinedstrflowStatusmay be undefinedStringFlowStatusmay be undefinedstringFlowStatusmay be undefined*string#Sets the status of the flow.
You can specify one of the following values:.
kmsArnmay be undefinedstringkms_arnmay be undefinedstrkmsArnmay be undefinedStringKmsArnmay be undefinedstringKmsArnmay be undefined*string#The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
metadataCatalogConfigmay be undefinedIResolvable | CfnFlow.MetadataCatalogConfigPropertymetadata_catalog_configmay be undefinedtyping.Union[IResolvable, MetadataCatalogConfigProperty]metadataCatalogConfigmay be undefinedIResolvableMetadataCatalogConfigmay be undefinedIResolvableMetadataCatalogConfigmay be undefinedinterface{}#Specifies the configuration that Amazon AppFlow uses when it catalogs your data.
Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
sourceFlowConfigIResolvable | CfnFlow.SourceFlowConfigPropertysource_flow_configtyping.Union[IResolvable, SourceFlowConfigProperty]sourceFlowConfigIResolvableSourceFlowConfigIResolvableSourceFlowConfiginterface{}#Contains information about the configuration of the source connector used in the flow.
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
Tag Manager which manages the tags for this resource.
tagsRawmay be undefinedCfnTag[]tags_rawmay be undefinedtyping.List[CfnTag]tagsRawmay be undefinedList<CfnTag>TagsRawmay be undefinedCfnTag[]TagsRawmay be undefined*[]CfnTag#The tags used to organize, track, or control access for your flow.
tasksIResolvable | IResolvable | CfnFlow.TaskProperty[]taskstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TaskProperty]]]tasksIResolvableTasksIResolvableTasksinterface{}#A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
triggerConfigIResolvable | CfnFlow.TriggerConfigPropertytrigger_configtyping.Union[IResolvable, TriggerConfigProperty]triggerConfigIResolvableTriggerConfigIResolvableTriggerConfiginterface{}#The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#Syntactic sugar for `addOverride(path, undefined)`.
1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#Use `addResourceDependency` instead.
This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#Use `addResourceDependency` instead.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters
To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.
For example,
typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
json
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#Adds an override that deletes the value of a property from the resource definition.
1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#Sets the deletion policy of the resource based on the removal policy specified.
notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:
cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#fromFlowArn(scope: Construct, id: string, arn: string): IFlowRef@staticmethod def from_flow_arn(scope: Construct, id: str, arn: str) -> IFlowRefpublic static IFlowRef fromFlowArn(Construct scope, String id, String arn)public static IFlowRef FromFlowArn(Construct scope, string id, string arn)func FromFlowArn(Scope Construct, Id *string, Arn *string) IFlowRefstatic#Creates a new IFlowRef from an ARN.
fromFlowName(scope: Construct, id: string, flowName: string): IFlowRef@staticmethod def from_flow_name(scope: Construct, id: str, flow_name: str) -> IFlowRefpublic static IFlowRef fromFlowName(Construct scope, String id, String flowName)public static IFlowRef FromFlowName(Construct scope, string id, string flowName)func FromFlowName(Scope Construct, Id *string, FlowName *string) IFlowRefstatic#Creates a new IFlowRef from a flowName.
getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#Examines the CloudFormation resource and discloses attributes.
1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnFlow(x: any): boolean@staticmethod def is_cfn_flow(x: Any) -> boolpublic static Boolean isCfnFlow(Object x)public static bool IsCfnFlow(object x)func IsCfnFlow(X interface{}) *boolstatic#Checks whether the given object is a CfnFlow.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#Check whether the given object is a CfnResource.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#Overrides the auto-generated logical ID with a specific ID.
1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#Use `removeResourceDependency` instead
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#Replaces one dependency with another.
2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.