class CfnFlow (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.AppFlow.CfnFlow`
Java	`software.amazon.awscdk.services.appflow.CfnFlow`
Python	`aws_cdk.aws_appflow.CfnFlow`
TypeScript	`@aws-cdk/aws-appflow` » `CfnFlow`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::AppFlow::Flow.

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

If you want to use AWS 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 * as appflow from '@aws-cdk/aws-appflow';
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',
        },
      },
      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',
      },
      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',
  }],
});

Initializer

new CfnFlow(scope: Construct, id: string, props: CfnFlowProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnFlowProps — - resource properties.

Create a new AWS::AppFlow::Flow.

Construct Props

Name	Type	Description
destinationFlowConfigList	`IResolvable` `\|` `IResolvable` `\|` `DestinationFlowConfigProperty[]`	The configuration that controls how Amazon AppFlow places data in the destination connector.
flowName	`string`	The specified name of the flow.
sourceFlowConfig	`IResolvable` `\|` `SourceFlowConfigProperty`	Contains information about the configuration of the source connector used in the flow.
tasks	`IResolvable` `\|` `IResolvable` `\|` `TaskProperty[]`	A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
triggerConfig	`IResolvable` `\|` `TriggerConfigProperty`	The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
description?	`string`	A user-entered description of the flow.
flowStatus?	`string`	Sets the status of the flow. You can specify one of the following values:.
kmsArn?	`string`	The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
metadataCatalogConfig?	`IResolvable` `\|` `MetadataCatalogConfigProperty`	`AWS::AppFlow::Flow.MetadataCatalogConfig`.
tags?	`CfnTag[]`	The tags used to organize, track, or control access for your flow.

destinationFlowConfigList

Type: IResolvable | IResolvable | DestinationFlowConfigProperty[]

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

flowName

Type: string

The specified name of the flow.

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

sourceFlowConfig

Type: IResolvable | SourceFlowConfigProperty

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

tasks

Type: IResolvable | IResolvable | TaskProperty[]

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

triggerConfig

Type: IResolvable | TriggerConfigProperty

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

description?

Type: string (optional)

A user-entered description of the flow.

flowStatus?

Type: string (optional)

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.

kmsArn?

Type: string (optional)

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.

metadataCatalogConfig?

Type: IResolvable | MetadataCatalogConfigProperty (optional)

AWS::AppFlow::Flow.MetadataCatalogConfig.

tags?

Type: CfnTag[] (optional)

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

Properties

Name	Type	Description
attrFlowArn	`string`	The flow's Amazon Resource Name (ARN).
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
destinationFlowConfigList	`IResolvable` `\|` `IResolvable` `\|` `DestinationFlowConfigProperty[]`	The configuration that controls how Amazon AppFlow places data in the destination connector.
flowName	`string`	The specified name of the flow.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
sourceFlowConfig	`IResolvable` `\|` `SourceFlowConfigProperty`	Contains information about the configuration of the source connector used in the flow.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	The tags used to organize, track, or control access for your flow.
tasks	`IResolvable` `\|` `IResolvable` `\|` `TaskProperty[]`	A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
triggerConfig	`IResolvable` `\|` `TriggerConfigProperty`	The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
description?	`string`	A user-entered description of the flow.
flowStatus?	`string`	Sets the status of the flow. You can specify one of the following values:.
kmsArn?	`string`	The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
metadataCatalogConfig?	`IResolvable` `\|` `MetadataCatalogConfigProperty`	`AWS::AppFlow::Flow.MetadataCatalogConfig`.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrFlowArn

Type: string

The flow's Amazon Resource Name (ARN).

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

destinationFlowConfigList

Type: IResolvable | IResolvable | DestinationFlowConfigProperty[]

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

flowName

Type: string

The specified name of the flow.

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

logicalId

Type: string

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).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

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 }).

sourceFlowConfig

Type: IResolvable | SourceFlowConfigProperty

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

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tasks

Type: IResolvable | IResolvable | TaskProperty[]

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

triggerConfig

Type: IResolvable | TriggerConfigProperty

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

description?

Type: string (optional)

A user-entered description of the flow.

flowStatus?

Type: string (optional)

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.

kmsArn?

Type: string (optional)

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.

metadataCatalogConfig?

Type: IResolvable | MetadataCatalogConfigProperty (optional)

AWS::AppFlow::Flow.MetadataCatalogConfig.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"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.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

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).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

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.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }