AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::AppFlow::Flow

CfnFlow

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.

Import

import { CfnFlow } from 'aws-cdk-lib/aws-appflow';

Or use the module namespace:

import * as appflow from 'aws-cdk-lib/aws-appflow';
// appflow.CfnFlow

Properties

Configuration passed to the constructor as CfnFlowProps.

destinationFlowConfigListRequired
IResolvable | IResolvable | DestinationFlowConfigProperty[]

The configuration that controls how Amazon AppFlow places data in the destination connector.

flowNameRequired
string

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

sourceFlowConfigRequired
IResolvable | SourceFlowConfigProperty

Contains information about the configuration of the source connector used in the flow.

tasksRequired
IResolvable | IResolvable | TaskProperty[]

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

triggerConfigRequired
IResolvable | TriggerConfigProperty

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

descriptionOptional
string

A user-entered description of the flow.

flowStatusOptional
string

Sets the status of the flow. You can specify one of the following values:. - **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.

kmsArnOptional
string | IKeyRef

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.

metadataCatalogConfigOptional
IResolvable | MetadataCatalogConfigProperty

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.

tagsOptional
CfnTag[]

The tags used to organize, track, or control access for your flow.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::AppFlow::FlowView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-appflow
CFN TypeAWS::AppFlow::Flow
Properties10

Related Constructs

Explore This Service

External Links