# API Reference ## Constructs ### AmazonRdsForPostgreSqlConnectorProfile The connector profile for the Amazon RDS for PostgreSQL connector. #### Initializers ```typescript import { AmazonRdsForPostgreSqlConnectorProfile } from '@cdklabs/cdk-appflow' new AmazonRdsForPostgreSqlConnectorProfile(scope: Construct, id: string, props: AmazonRdsForPostgreSqlConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | the Construct scope for this connector profile. | | id | string | the id of this connector profile. | | props | AmazonRdsForPostgreSqlConnectorProfileProps | properties to use when instantiating this connector profile. | --- ##### `scope`^Required - *Type:* constructs.Construct the Construct scope for this connector profile. --- ##### `id`^Required - *Type:* string the id of this connector profile. --- ##### `props`^Required - *Type:* AmazonRdsForPostgreSqlConnectorProfileProps properties to use when instantiating this connector profile. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | Imports an existing AmazonRdsForPostgreSqlConnectorProfile. | | fromConnectionProfileName | Imports an existing AmazonRdsForPostgreSqlConnectorProfile. | --- ##### ~~`isConstruct`~~ ```typescript import { AmazonRdsForPostgreSqlConnectorProfile } from '@cdklabs/cdk-appflow' AmazonRdsForPostgreSqlConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { AmazonRdsForPostgreSqlConnectorProfile } from '@cdklabs/cdk-appflow' AmazonRdsForPostgreSqlConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { AmazonRdsForPostgreSqlConnectorProfile } from '@cdklabs/cdk-appflow' AmazonRdsForPostgreSqlConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { AmazonRdsForPostgreSqlConnectorProfile } from '@cdklabs/cdk-appflow' AmazonRdsForPostgreSqlConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` Imports an existing AmazonRdsForPostgreSqlConnectorProfile. ###### `scope`^Required - *Type:* constructs.Construct the scope for the connector profile. --- ###### `id`^Required - *Type:* string the connector profile's ID. --- ###### `arn`^Required - *Type:* string the ARN for the existing connector profile. --- ##### `fromConnectionProfileName` ```typescript import { AmazonRdsForPostgreSqlConnectorProfile } from '@cdklabs/cdk-appflow' AmazonRdsForPostgreSqlConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` Imports an existing AmazonRdsForPostgreSqlConnectorProfile. ###### `scope`^Required - *Type:* constructs.Construct the scope for the connector profile. --- ###### `id`^Required - *Type:* string the connector profile's ID. --- ###### `name`^Required - *Type:* string the name for the existing connector profile. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### AsanaConnectorProfile A class that represents a Asana Connector Profile. #### Initializers ```typescript import { AsanaConnectorProfile } from '@cdklabs/cdk-appflow' new AsanaConnectorProfile(scope: Construct, id: string, props: AsanaConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AsanaConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* AsanaConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { AsanaConnectorProfile } from '@cdklabs/cdk-appflow' AsanaConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { AsanaConnectorProfile } from '@cdklabs/cdk-appflow' AsanaConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { AsanaConnectorProfile } from '@cdklabs/cdk-appflow' AsanaConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { AsanaConnectorProfile } from '@cdklabs/cdk-appflow' AsanaConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { AsanaConnectorProfile } from '@cdklabs/cdk-appflow' AsanaConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### ConnectorProfileBase - *Implements:* IConnectorProfile #### Initializers ```typescript import { ConnectorProfileBase } from '@cdklabs/cdk-appflow' new ConnectorProfileBase(scope: Construct, id: string, props: ConnectorProfileProps, connectorType: ConnectorType) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ConnectorProfileProps | *No description.* | | connectorType | ConnectorType | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ConnectorProfileProps --- ##### `connectorType`^Required - *Type:* ConnectorType --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { ConnectorProfileBase } from '@cdklabs/cdk-appflow' ConnectorProfileBase.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { ConnectorProfileBase } from '@cdklabs/cdk-appflow' ConnectorProfileBase.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ConnectorProfileBase } from '@cdklabs/cdk-appflow' ConnectorProfileBase.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### FlowBase - *Implements:* IFlow #### Initializers ```typescript import { FlowBase } from '@cdklabs/cdk-appflow' new FlowBase(scope: Construct, id: string, props: FlowBaseProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | FlowBaseProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* FlowBaseProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | metric | *No description.* | | metricFlowExecutionRecordsProcessed | Creates a metric to report the number of records that Amazon AppFlow attempted to transfer for the flow run. | | metricFlowExecutionsFailed | Creates a metric to report the number of failed flow runs. | | metricFlowExecutionsStarted | Creates a metric to report the number of flow runs started. | | metricFlowExecutionsSucceeded | Creates a metric to report the number of successful flow runs. | | metricFlowExecutionTime | Creates a metric to report the interval, in milliseconds, between the time the flow starts and the time it finishes. | | onEvent | *No description.* | | onRunCompleted | *No description.* | | onRunStarted | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `metric` ```typescript public metric(metricName: string, options?: MetricOptions): Metric ``` ###### `metricName`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionRecordsProcessed` ```typescript public metricFlowExecutionRecordsProcessed(options?: MetricOptions): Metric ``` Creates a metric to report the number of records that Amazon AppFlow attempted to transfer for the flow run. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsFailed` ```typescript public metricFlowExecutionsFailed(options?: MetricOptions): Metric ``` Creates a metric to report the number of failed flow runs. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsStarted` ```typescript public metricFlowExecutionsStarted(options?: MetricOptions): Metric ``` Creates a metric to report the number of flow runs started. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsSucceeded` ```typescript public metricFlowExecutionsSucceeded(options?: MetricOptions): Metric ``` Creates a metric to report the number of successful flow runs. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionTime` ```typescript public metricFlowExecutionTime(options?: MetricOptions): Metric ``` Creates a metric to report the interval, in milliseconds, between the time the flow starts and the time it finishes. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `onEvent` ```typescript public onEvent(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onRunCompleted` ```typescript public onRunCompleted(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onRunStarted` ```typescript public onRunStarted(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { FlowBase } from '@cdklabs/cdk-appflow' FlowBase.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { FlowBase } from '@cdklabs/cdk-appflow' FlowBase.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { FlowBase } from '@cdklabs/cdk-appflow' FlowBase.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | The ARN of the flow. | | name | string | The name of the flow. | | type | FlowType | The type of the flow. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string The ARN of the flow. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the flow. --- ##### `type`^Required ```typescript public readonly type: FlowType; ``` - *Type:* FlowType The type of the flow. --- ### GoogleAdsConnectorProfile #### Initializers ```typescript import { GoogleAdsConnectorProfile } from '@cdklabs/cdk-appflow' new GoogleAdsConnectorProfile(scope: Construct, id: string, props: GoogleAdsConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | GoogleAdsConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* GoogleAdsConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { GoogleAdsConnectorProfile } from '@cdklabs/cdk-appflow' GoogleAdsConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { GoogleAdsConnectorProfile } from '@cdklabs/cdk-appflow' GoogleAdsConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { GoogleAdsConnectorProfile } from '@cdklabs/cdk-appflow' GoogleAdsConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { GoogleAdsConnectorProfile } from '@cdklabs/cdk-appflow' GoogleAdsConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { GoogleAdsConnectorProfile } from '@cdklabs/cdk-appflow' GoogleAdsConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### GoogleAnalytics4ConnectorProfile #### Initializers ```typescript import { GoogleAnalytics4ConnectorProfile } from '@cdklabs/cdk-appflow' new GoogleAnalytics4ConnectorProfile(scope: Construct, id: string, props: GoogleAnalytics4ConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | GoogleAnalytics4ConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* GoogleAnalytics4ConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { GoogleAnalytics4ConnectorProfile } from '@cdklabs/cdk-appflow' GoogleAnalytics4ConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { GoogleAnalytics4ConnectorProfile } from '@cdklabs/cdk-appflow' GoogleAnalytics4ConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { GoogleAnalytics4ConnectorProfile } from '@cdklabs/cdk-appflow' GoogleAnalytics4ConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { GoogleAnalytics4ConnectorProfile } from '@cdklabs/cdk-appflow' GoogleAnalytics4ConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { GoogleAnalytics4ConnectorProfile } from '@cdklabs/cdk-appflow' GoogleAnalytics4ConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### GoogleBigQueryConnectorProfile #### Initializers ```typescript import { GoogleBigQueryConnectorProfile } from '@cdklabs/cdk-appflow' new GoogleBigQueryConnectorProfile(scope: Construct, id: string, props: GoogleBigQueryConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | GoogleBigQueryConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* GoogleBigQueryConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { GoogleBigQueryConnectorProfile } from '@cdklabs/cdk-appflow' GoogleBigQueryConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { GoogleBigQueryConnectorProfile } from '@cdklabs/cdk-appflow' GoogleBigQueryConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { GoogleBigQueryConnectorProfile } from '@cdklabs/cdk-appflow' GoogleBigQueryConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { GoogleBigQueryConnectorProfile } from '@cdklabs/cdk-appflow' GoogleBigQueryConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { GoogleBigQueryConnectorProfile } from '@cdklabs/cdk-appflow' GoogleBigQueryConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### HubSpotConnectorProfile #### Initializers ```typescript import { HubSpotConnectorProfile } from '@cdklabs/cdk-appflow' new HubSpotConnectorProfile(scope: Construct, id: string, props: HubSpotConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | HubSpotConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* HubSpotConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { HubSpotConnectorProfile } from '@cdklabs/cdk-appflow' HubSpotConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { HubSpotConnectorProfile } from '@cdklabs/cdk-appflow' HubSpotConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { HubSpotConnectorProfile } from '@cdklabs/cdk-appflow' HubSpotConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { HubSpotConnectorProfile } from '@cdklabs/cdk-appflow' HubSpotConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { HubSpotConnectorProfile } from '@cdklabs/cdk-appflow' HubSpotConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### JdbcSmallDataScaleConnectorProfile The connector profile for the JDBC connector. #### Initializers ```typescript import { JdbcSmallDataScaleConnectorProfile } from '@cdklabs/cdk-appflow' new JdbcSmallDataScaleConnectorProfile(scope: Construct, id: string, props: JdbcSmallDataScaleConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | the Construct scope for this connector profile. | | id | string | the id of this connector profile. | | props | JdbcSmallDataScaleConnectorProfileProps | properties to use when instantiating this connector profile. | --- ##### `scope`^Required - *Type:* constructs.Construct the Construct scope for this connector profile. --- ##### `id`^Required - *Type:* string the id of this connector profile. --- ##### `props`^Required - *Type:* JdbcSmallDataScaleConnectorProfileProps properties to use when instantiating this connector profile. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | Imports an existing JdbcSmallDataScaleConnectorProfile. | | fromConnectionProfileName | Imports an existing JdbcSmallDataScaleConnectorProfile. | --- ##### ~~`isConstruct`~~ ```typescript import { JdbcSmallDataScaleConnectorProfile } from '@cdklabs/cdk-appflow' JdbcSmallDataScaleConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { JdbcSmallDataScaleConnectorProfile } from '@cdklabs/cdk-appflow' JdbcSmallDataScaleConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { JdbcSmallDataScaleConnectorProfile } from '@cdklabs/cdk-appflow' JdbcSmallDataScaleConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { JdbcSmallDataScaleConnectorProfile } from '@cdklabs/cdk-appflow' JdbcSmallDataScaleConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` Imports an existing JdbcSmallDataScaleConnectorProfile. ###### `scope`^Required - *Type:* constructs.Construct the scope for the connector profile. --- ###### `id`^Required - *Type:* string the connector profile's ID. --- ###### `arn`^Required - *Type:* string the ARN for the existing connector profile. --- ##### `fromConnectionProfileName` ```typescript import { JdbcSmallDataScaleConnectorProfile } from '@cdklabs/cdk-appflow' JdbcSmallDataScaleConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` Imports an existing JdbcSmallDataScaleConnectorProfile. ###### `scope`^Required - *Type:* constructs.Construct the scope for the connector profile. --- ###### `id`^Required - *Type:* string the connector profile's ID. --- ###### `name`^Required - *Type:* string the name for the existing connector profile. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### MailchimpConnectorProfile A class that represents a Mailchimp Connector Profile. #### Initializers ```typescript import { MailchimpConnectorProfile } from '@cdklabs/cdk-appflow' new MailchimpConnectorProfile(scope: Construct, id: string, props: MailchimpConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MailchimpConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* MailchimpConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { MailchimpConnectorProfile } from '@cdklabs/cdk-appflow' MailchimpConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { MailchimpConnectorProfile } from '@cdklabs/cdk-appflow' MailchimpConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { MailchimpConnectorProfile } from '@cdklabs/cdk-appflow' MailchimpConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { MailchimpConnectorProfile } from '@cdklabs/cdk-appflow' MailchimpConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { MailchimpConnectorProfile } from '@cdklabs/cdk-appflow' MailchimpConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### MarketoConnectorProfile #### Initializers ```typescript import { MarketoConnectorProfile } from '@cdklabs/cdk-appflow' new MarketoConnectorProfile(scope: Construct, id: string, props: MarketoConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MarketoConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* MarketoConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { MarketoConnectorProfile } from '@cdklabs/cdk-appflow' MarketoConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { MarketoConnectorProfile } from '@cdklabs/cdk-appflow' MarketoConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { MarketoConnectorProfile } from '@cdklabs/cdk-appflow' MarketoConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { MarketoConnectorProfile } from '@cdklabs/cdk-appflow' MarketoConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { MarketoConnectorProfile } from '@cdklabs/cdk-appflow' MarketoConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### MicrosoftDynamics365ConnectorProfile A class that represents a Microsoft Dynamics 365 Connector Profile. This connector profile allows to transfer document libraries residing on a Microsoft Dynamics 365's site to Amazon S3. #### Initializers ```typescript import { MicrosoftDynamics365ConnectorProfile } from '@cdklabs/cdk-appflow' new MicrosoftDynamics365ConnectorProfile(scope: Construct, id: string, props: MicrosoftDynamics365ConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MicrosoftDynamics365ConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* MicrosoftDynamics365ConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { MicrosoftDynamics365ConnectorProfile } from '@cdklabs/cdk-appflow' MicrosoftDynamics365ConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { MicrosoftDynamics365ConnectorProfile } from '@cdklabs/cdk-appflow' MicrosoftDynamics365ConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { MicrosoftDynamics365ConnectorProfile } from '@cdklabs/cdk-appflow' MicrosoftDynamics365ConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { MicrosoftDynamics365ConnectorProfile } from '@cdklabs/cdk-appflow' MicrosoftDynamics365ConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { MicrosoftDynamics365ConnectorProfile } from '@cdklabs/cdk-appflow' MicrosoftDynamics365ConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### MicrosoftSharepointOnlineConnectorProfile A class that represents a Microsoft Sharepoint Online Connector Profile. This connector profile allows to transfer document libraries residing on a Microsoft Sharepoint Online's site to Amazon S3. #### Initializers ```typescript import { MicrosoftSharepointOnlineConnectorProfile } from '@cdklabs/cdk-appflow' new MicrosoftSharepointOnlineConnectorProfile(scope: Construct, id: string, props: MicrosoftSharepointOnlineConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MicrosoftSharepointOnlineConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* MicrosoftSharepointOnlineConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { MicrosoftSharepointOnlineConnectorProfile } from '@cdklabs/cdk-appflow' MicrosoftSharepointOnlineConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { MicrosoftSharepointOnlineConnectorProfile } from '@cdklabs/cdk-appflow' MicrosoftSharepointOnlineConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { MicrosoftSharepointOnlineConnectorProfile } from '@cdklabs/cdk-appflow' MicrosoftSharepointOnlineConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { MicrosoftSharepointOnlineConnectorProfile } from '@cdklabs/cdk-appflow' MicrosoftSharepointOnlineConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { MicrosoftSharepointOnlineConnectorProfile } from '@cdklabs/cdk-appflow' MicrosoftSharepointOnlineConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### OnDemandFlow - *Implements:* IFlow #### Initializers ```typescript import { OnDemandFlow } from '@cdklabs/cdk-appflow' new OnDemandFlow(scope: Construct, id: string, props: OnDemandFlowProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | OnDemandFlowProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* OnDemandFlowProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | metric | *No description.* | | metricFlowExecutionRecordsProcessed | Creates a metric to report the number of records that Amazon AppFlow attempted to transfer for the flow run. | | metricFlowExecutionsFailed | Creates a metric to report the number of failed flow runs. | | metricFlowExecutionsStarted | Creates a metric to report the number of flow runs started. | | metricFlowExecutionsSucceeded | Creates a metric to report the number of successful flow runs. | | metricFlowExecutionTime | Creates a metric to report the interval, in milliseconds, between the time the flow starts and the time it finishes. | | onEvent | *No description.* | | onRunCompleted | *No description.* | | onRunStarted | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `metric` ```typescript public metric(metricName: string, options?: MetricOptions): Metric ``` ###### `metricName`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionRecordsProcessed` ```typescript public metricFlowExecutionRecordsProcessed(options?: MetricOptions): Metric ``` Creates a metric to report the number of records that Amazon AppFlow attempted to transfer for the flow run. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsFailed` ```typescript public metricFlowExecutionsFailed(options?: MetricOptions): Metric ``` Creates a metric to report the number of failed flow runs. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsStarted` ```typescript public metricFlowExecutionsStarted(options?: MetricOptions): Metric ``` Creates a metric to report the number of flow runs started. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsSucceeded` ```typescript public metricFlowExecutionsSucceeded(options?: MetricOptions): Metric ``` Creates a metric to report the number of successful flow runs. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionTime` ```typescript public metricFlowExecutionTime(options?: MetricOptions): Metric ``` Creates a metric to report the interval, in milliseconds, between the time the flow starts and the time it finishes. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `onEvent` ```typescript public onEvent(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onRunCompleted` ```typescript public onRunCompleted(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onRunStarted` ```typescript public onRunStarted(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { OnDemandFlow } from '@cdklabs/cdk-appflow' OnDemandFlow.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { OnDemandFlow } from '@cdklabs/cdk-appflow' OnDemandFlow.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { OnDemandFlow } from '@cdklabs/cdk-appflow' OnDemandFlow.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | The ARN of the flow. | | name | string | The name of the flow. | | type | FlowType | The type of the flow. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string The ARN of the flow. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the flow. --- ##### `type`^Required ```typescript public readonly type: FlowType; ``` - *Type:* FlowType The type of the flow. --- ### OnEventFlow - *Implements:* IFlow #### Initializers ```typescript import { OnEventFlow } from '@cdklabs/cdk-appflow' new OnEventFlow(scope: Construct, id: string, props: OnEventFlowProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | OnEventFlowProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* OnEventFlowProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | metric | *No description.* | | metricFlowExecutionRecordsProcessed | Creates a metric to report the number of records that Amazon AppFlow attempted to transfer for the flow run. | | metricFlowExecutionsFailed | Creates a metric to report the number of failed flow runs. | | metricFlowExecutionsStarted | Creates a metric to report the number of flow runs started. | | metricFlowExecutionsSucceeded | Creates a metric to report the number of successful flow runs. | | metricFlowExecutionTime | Creates a metric to report the interval, in milliseconds, between the time the flow starts and the time it finishes. | | onEvent | *No description.* | | onRunCompleted | *No description.* | | onRunStarted | *No description.* | | onDeactivated | *No description.* | | onStatus | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `metric` ```typescript public metric(metricName: string, options?: MetricOptions): Metric ``` ###### `metricName`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionRecordsProcessed` ```typescript public metricFlowExecutionRecordsProcessed(options?: MetricOptions): Metric ``` Creates a metric to report the number of records that Amazon AppFlow attempted to transfer for the flow run. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsFailed` ```typescript public metricFlowExecutionsFailed(options?: MetricOptions): Metric ``` Creates a metric to report the number of failed flow runs. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsStarted` ```typescript public metricFlowExecutionsStarted(options?: MetricOptions): Metric ``` Creates a metric to report the number of flow runs started. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsSucceeded` ```typescript public metricFlowExecutionsSucceeded(options?: MetricOptions): Metric ``` Creates a metric to report the number of successful flow runs. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionTime` ```typescript public metricFlowExecutionTime(options?: MetricOptions): Metric ``` Creates a metric to report the interval, in milliseconds, between the time the flow starts and the time it finishes. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `onEvent` ```typescript public onEvent(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onRunCompleted` ```typescript public onRunCompleted(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onRunStarted` ```typescript public onRunStarted(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onDeactivated` ```typescript public onDeactivated(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onStatus` ```typescript public onStatus(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { OnEventFlow } from '@cdklabs/cdk-appflow' OnEventFlow.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { OnEventFlow } from '@cdklabs/cdk-appflow' OnEventFlow.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { OnEventFlow } from '@cdklabs/cdk-appflow' OnEventFlow.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | The ARN of the flow. | | name | string | The name of the flow. | | type | FlowType | The type of the flow. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string The ARN of the flow. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the flow. --- ##### `type`^Required ```typescript public readonly type: FlowType; ``` - *Type:* FlowType The type of the flow. --- ### OnScheduleFlow - *Implements:* IFlow #### Initializers ```typescript import { OnScheduleFlow } from '@cdklabs/cdk-appflow' new OnScheduleFlow(scope: Construct, id: string, props: OnScheduleFlowProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | OnScheduleFlowProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* OnScheduleFlowProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | metric | *No description.* | | metricFlowExecutionRecordsProcessed | Creates a metric to report the number of records that Amazon AppFlow attempted to transfer for the flow run. | | metricFlowExecutionsFailed | Creates a metric to report the number of failed flow runs. | | metricFlowExecutionsStarted | Creates a metric to report the number of flow runs started. | | metricFlowExecutionsSucceeded | Creates a metric to report the number of successful flow runs. | | metricFlowExecutionTime | Creates a metric to report the interval, in milliseconds, between the time the flow starts and the time it finishes. | | onEvent | *No description.* | | onRunCompleted | *No description.* | | onRunStarted | *No description.* | | onDeactivated | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `metric` ```typescript public metric(metricName: string, options?: MetricOptions): Metric ``` ###### `metricName`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionRecordsProcessed` ```typescript public metricFlowExecutionRecordsProcessed(options?: MetricOptions): Metric ``` Creates a metric to report the number of records that Amazon AppFlow attempted to transfer for the flow run. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsFailed` ```typescript public metricFlowExecutionsFailed(options?: MetricOptions): Metric ``` Creates a metric to report the number of failed flow runs. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsStarted` ```typescript public metricFlowExecutionsStarted(options?: MetricOptions): Metric ``` Creates a metric to report the number of flow runs started. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsSucceeded` ```typescript public metricFlowExecutionsSucceeded(options?: MetricOptions): Metric ``` Creates a metric to report the number of successful flow runs. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionTime` ```typescript public metricFlowExecutionTime(options?: MetricOptions): Metric ``` Creates a metric to report the interval, in milliseconds, between the time the flow starts and the time it finishes. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `onEvent` ```typescript public onEvent(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onRunCompleted` ```typescript public onRunCompleted(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onRunStarted` ```typescript public onRunStarted(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onDeactivated` ```typescript public onDeactivated(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { OnScheduleFlow } from '@cdklabs/cdk-appflow' OnScheduleFlow.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { OnScheduleFlow } from '@cdklabs/cdk-appflow' OnScheduleFlow.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { OnScheduleFlow } from '@cdklabs/cdk-appflow' OnScheduleFlow.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | The ARN of the flow. | | name | string | The name of the flow. | | type | FlowType | The type of the flow. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string The ARN of the flow. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the flow. --- ##### `type`^Required ```typescript public readonly type: FlowType; ``` - *Type:* FlowType The type of the flow. --- ### RedshiftConnectorProfile #### Initializers ```typescript import { RedshiftConnectorProfile } from '@cdklabs/cdk-appflow' new RedshiftConnectorProfile(scope: Construct, id: string, props: RedshiftConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RedshiftConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RedshiftConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { RedshiftConnectorProfile } from '@cdklabs/cdk-appflow' RedshiftConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { RedshiftConnectorProfile } from '@cdklabs/cdk-appflow' RedshiftConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RedshiftConnectorProfile } from '@cdklabs/cdk-appflow' RedshiftConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { RedshiftConnectorProfile } from '@cdklabs/cdk-appflow' RedshiftConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { RedshiftConnectorProfile } from '@cdklabs/cdk-appflow' RedshiftConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### SalesforceConnectorProfile #### Initializers ```typescript import { SalesforceConnectorProfile } from '@cdklabs/cdk-appflow' new SalesforceConnectorProfile(scope: Construct, id: string, props: SalesforceConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | SalesforceConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SalesforceConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { SalesforceConnectorProfile } from '@cdklabs/cdk-appflow' SalesforceConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { SalesforceConnectorProfile } from '@cdklabs/cdk-appflow' SalesforceConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SalesforceConnectorProfile } from '@cdklabs/cdk-appflow' SalesforceConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { SalesforceConnectorProfile } from '@cdklabs/cdk-appflow' SalesforceConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { SalesforceConnectorProfile } from '@cdklabs/cdk-appflow' SalesforceConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### SalesforceMarketingCloudConnectorProfile #### Initializers ```typescript import { SalesforceMarketingCloudConnectorProfile } from '@cdklabs/cdk-appflow' new SalesforceMarketingCloudConnectorProfile(scope: Construct, id: string, props: SalesforceMarketingCloudConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | SalesforceMarketingCloudConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SalesforceMarketingCloudConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { SalesforceMarketingCloudConnectorProfile } from '@cdklabs/cdk-appflow' SalesforceMarketingCloudConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { SalesforceMarketingCloudConnectorProfile } from '@cdklabs/cdk-appflow' SalesforceMarketingCloudConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SalesforceMarketingCloudConnectorProfile } from '@cdklabs/cdk-appflow' SalesforceMarketingCloudConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { SalesforceMarketingCloudConnectorProfile } from '@cdklabs/cdk-appflow' SalesforceMarketingCloudConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { SalesforceMarketingCloudConnectorProfile } from '@cdklabs/cdk-appflow' SalesforceMarketingCloudConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### SAPOdataConnectorProfile #### Initializers ```typescript import { SAPOdataConnectorProfile } from '@cdklabs/cdk-appflow' new SAPOdataConnectorProfile(scope: Construct, id: string, props: SAPOdataConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | SAPOdataConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SAPOdataConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { SAPOdataConnectorProfile } from '@cdklabs/cdk-appflow' SAPOdataConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { SAPOdataConnectorProfile } from '@cdklabs/cdk-appflow' SAPOdataConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SAPOdataConnectorProfile } from '@cdklabs/cdk-appflow' SAPOdataConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { SAPOdataConnectorProfile } from '@cdklabs/cdk-appflow' SAPOdataConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { SAPOdataConnectorProfile } from '@cdklabs/cdk-appflow' SAPOdataConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### ServiceNowConnectorProfile #### Initializers ```typescript import { ServiceNowConnectorProfile } from '@cdklabs/cdk-appflow' new ServiceNowConnectorProfile(scope: Construct, id: string, props: ServiceNowConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ServiceNowConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ServiceNowConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { ServiceNowConnectorProfile } from '@cdklabs/cdk-appflow' ServiceNowConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { ServiceNowConnectorProfile } from '@cdklabs/cdk-appflow' ServiceNowConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ServiceNowConnectorProfile } from '@cdklabs/cdk-appflow' ServiceNowConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { ServiceNowConnectorProfile } from '@cdklabs/cdk-appflow' ServiceNowConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { ServiceNowConnectorProfile } from '@cdklabs/cdk-appflow' ServiceNowConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### SlackConnectorProfile #### Initializers ```typescript import { SlackConnectorProfile } from '@cdklabs/cdk-appflow' new SlackConnectorProfile(scope: Construct, id: string, props: SlackConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | SlackConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SlackConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { SlackConnectorProfile } from '@cdklabs/cdk-appflow' SlackConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { SlackConnectorProfile } from '@cdklabs/cdk-appflow' SlackConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SlackConnectorProfile } from '@cdklabs/cdk-appflow' SlackConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { SlackConnectorProfile } from '@cdklabs/cdk-appflow' SlackConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { SlackConnectorProfile } from '@cdklabs/cdk-appflow' SlackConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### SnowflakeConnectorProfile #### Initializers ```typescript import { SnowflakeConnectorProfile } from '@cdklabs/cdk-appflow' new SnowflakeConnectorProfile(scope: Construct, id: string, props: SnowflakeConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | SnowflakeConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SnowflakeConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { SnowflakeConnectorProfile } from '@cdklabs/cdk-appflow' SnowflakeConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { SnowflakeConnectorProfile } from '@cdklabs/cdk-appflow' SnowflakeConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SnowflakeConnectorProfile } from '@cdklabs/cdk-appflow' SnowflakeConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { SnowflakeConnectorProfile } from '@cdklabs/cdk-appflow' SnowflakeConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { SnowflakeConnectorProfile } from '@cdklabs/cdk-appflow' SnowflakeConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | | integrationRole | aws-cdk-lib.aws_iam.IRole | The AWS IAM Role for the storage integration with Snowflake. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ##### `integrationRole`^Optional ```typescript public readonly integrationRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole The AWS IAM Role for the storage integration with Snowflake. Available only if [SnowflakeConnectorProfileProps's integration property]{@link SnowflakeConnectorProfileProps#integration } is provided. For more details see {@link https://docs.snowflake.com/en/user-guide/data-load-s3-config-storage-integration} --- ### TriggeredFlowBase - *Implements:* IFlow A base class for triggered flows. #### Initializers ```typescript import { TriggeredFlowBase } from '@cdklabs/cdk-appflow' new TriggeredFlowBase(scope: Construct, id: string, props: FlowBaseProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | FlowBaseProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* FlowBaseProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | metric | *No description.* | | metricFlowExecutionRecordsProcessed | Creates a metric to report the number of records that Amazon AppFlow attempted to transfer for the flow run. | | metricFlowExecutionsFailed | Creates a metric to report the number of failed flow runs. | | metricFlowExecutionsStarted | Creates a metric to report the number of flow runs started. | | metricFlowExecutionsSucceeded | Creates a metric to report the number of successful flow runs. | | metricFlowExecutionTime | Creates a metric to report the interval, in milliseconds, between the time the flow starts and the time it finishes. | | onEvent | *No description.* | | onRunCompleted | *No description.* | | onRunStarted | *No description.* | | onDeactivated | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `metric` ```typescript public metric(metricName: string, options?: MetricOptions): Metric ``` ###### `metricName`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionRecordsProcessed` ```typescript public metricFlowExecutionRecordsProcessed(options?: MetricOptions): Metric ``` Creates a metric to report the number of records that Amazon AppFlow attempted to transfer for the flow run. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsFailed` ```typescript public metricFlowExecutionsFailed(options?: MetricOptions): Metric ``` Creates a metric to report the number of failed flow runs. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsStarted` ```typescript public metricFlowExecutionsStarted(options?: MetricOptions): Metric ``` Creates a metric to report the number of flow runs started. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsSucceeded` ```typescript public metricFlowExecutionsSucceeded(options?: MetricOptions): Metric ``` Creates a metric to report the number of successful flow runs. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionTime` ```typescript public metricFlowExecutionTime(options?: MetricOptions): Metric ``` Creates a metric to report the interval, in milliseconds, between the time the flow starts and the time it finishes. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `onEvent` ```typescript public onEvent(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onRunCompleted` ```typescript public onRunCompleted(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onRunStarted` ```typescript public onRunStarted(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onDeactivated` ```typescript public onDeactivated(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { TriggeredFlowBase } from '@cdklabs/cdk-appflow' TriggeredFlowBase.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { TriggeredFlowBase } from '@cdklabs/cdk-appflow' TriggeredFlowBase.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { TriggeredFlowBase } from '@cdklabs/cdk-appflow' TriggeredFlowBase.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | The ARN of the flow. | | name | string | The name of the flow. | | type | FlowType | The type of the flow. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string The ARN of the flow. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the flow. --- ##### `type`^Required ```typescript public readonly type: FlowType; ``` - *Type:* FlowType The type of the flow. --- ### ZendeskConnectorProfile #### Initializers ```typescript import { ZendeskConnectorProfile } from '@cdklabs/cdk-appflow' new ZendeskConnectorProfile(scope: Construct, id: string, props: ZendeskConnectorProfileProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ZendeskConnectorProfileProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ZendeskConnectorProfileProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. 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`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromConnectionProfileArn | *No description.* | | fromConnectionProfileName | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { ZendeskConnectorProfile } from '@cdklabs/cdk-appflow' ZendeskConnectorProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { ZendeskConnectorProfile } from '@cdklabs/cdk-appflow' ZendeskConnectorProfile.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ZendeskConnectorProfile } from '@cdklabs/cdk-appflow' ZendeskConnectorProfile.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromConnectionProfileArn` ```typescript import { ZendeskConnectorProfile } from '@cdklabs/cdk-appflow' ZendeskConnectorProfile.fromConnectionProfileArn(scope: Construct, id: string, arn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromConnectionProfileName` ```typescript import { ZendeskConnectorProfile } from '@cdklabs/cdk-appflow' ZendeskConnectorProfile.fromConnectionProfileName(scope: Construct, id: string, name: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ## Structs ### AmazonRdsForPostgreSqlBasicAuthSettings Basic authentication settings for the AmazonRdsForPostgreSqlConnectorProfile. #### Initializer ```typescript import { AmazonRdsForPostgreSqlBasicAuthSettings } from '@cdklabs/cdk-appflow' const amazonRdsForPostgreSqlBasicAuthSettings: AmazonRdsForPostgreSqlBasicAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | password | aws-cdk-lib.SecretValue | The password of the identity used for interacting with the Amazon RDS for PostgreSQL. | | username | string | The username of the identity used for interacting with the Amazon RDS for PostgreSQL. | --- ##### `password`^Required ```typescript public readonly password: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue The password of the identity used for interacting with the Amazon RDS for PostgreSQL. --- ##### `username`^Required ```typescript public readonly username: string; ``` - *Type:* string The username of the identity used for interacting with the Amazon RDS for PostgreSQL. --- ### AmazonRdsForPostgreSqlConnectorProfileProps Properties of the AmazonRdsForPostgreSqlConnectorProfile. #### Initializer ```typescript import { AmazonRdsForPostgreSqlConnectorProfileProps } from '@cdklabs/cdk-appflow' const amazonRdsForPostgreSqlConnectorProfileProps: AmazonRdsForPostgreSqlConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | basicAuth | AmazonRdsForPostgreSqlBasicAuthSettings | The auth settings for the profile. | | database | string | The name of the PostgreSQL database. | | hostname | string | The PostgreSQL hostname. | | port | number | The PostgreSQL communication port. | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `basicAuth`^Required ```typescript public readonly basicAuth: AmazonRdsForPostgreSqlBasicAuthSettings; ``` - *Type:* AmazonRdsForPostgreSqlBasicAuthSettings The auth settings for the profile. --- ##### `database`^Required ```typescript public readonly database: string; ``` - *Type:* string The name of the PostgreSQL database. --- ##### `hostname`^Required ```typescript public readonly hostname: string; ``` - *Type:* string The PostgreSQL hostname. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number The PostgreSQL communication port. --- ### AmazonRdsForPostgreSqlDestinationProps Properties of the AmazonRdsForPostgreSqlDestination. #### Initializer ```typescript import { AmazonRdsForPostgreSqlDestinationProps } from '@cdklabs/cdk-appflow' const amazonRdsForPostgreSqlDestinationProps: AmazonRdsForPostgreSqlDestinationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | object | AmazonRdsForPostgreSqlObject | The destination object table to write to. | | profile | AmazonRdsForPostgreSqlConnectorProfile | The profile to use with the destination. | | apiVersion | string | The Amazon AppFlow Api Version. | | errorHandling | ErrorHandlingConfiguration | The settings that determine how Amazon AppFlow handles an error when placing data in the destination. | --- ##### `object`^Required ```typescript public readonly object: AmazonRdsForPostgreSqlObject; ``` - *Type:* AmazonRdsForPostgreSqlObject The destination object table to write to. --- ##### `profile`^Required ```typescript public readonly profile: AmazonRdsForPostgreSqlConnectorProfile; ``` - *Type:* AmazonRdsForPostgreSqlConnectorProfile The profile to use with the destination. --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string The Amazon AppFlow Api Version. --- ##### `errorHandling`^Optional ```typescript public readonly errorHandling: ErrorHandlingConfiguration; ``` - *Type:* ErrorHandlingConfiguration The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. --- ### AmazonRdsForPostgreSqlObject The definition of the Amazon AppFlow object for Amazon RDS for PostgreSQL. #### Initializer ```typescript import { AmazonRdsForPostgreSqlObject } from '@cdklabs/cdk-appflow' const amazonRdsForPostgreSqlObject: AmazonRdsForPostgreSqlObject = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | schema | string | PostgreSQL schema name of the table. | | table | string | PostgreSQL table name. | --- ##### `schema`^Required ```typescript public readonly schema: string; ``` - *Type:* string PostgreSQL schema name of the table. --- ##### `table`^Required ```typescript public readonly table: string; ``` - *Type:* string PostgreSQL table name. --- ### AsanaConnectorProfileProps #### Initializer ```typescript import { AsanaConnectorProfileProps } from '@cdklabs/cdk-appflow' const asanaConnectorProfileProps: AsanaConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | patToken | aws-cdk-lib.SecretValue | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `patToken`^Required ```typescript public readonly patToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ### AsanaSourceProps #### Initializer ```typescript import { AsanaSourceProps } from '@cdklabs/cdk-appflow' const asanaSourceProps: AsanaSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | object | string | *No description.* | | profile | AsanaConnectorProfile | *No description.* | | apiVersion | string | *No description.* | --- ##### `object`^Required ```typescript public readonly object: string; ``` - *Type:* string --- ##### `profile`^Required ```typescript public readonly profile: AsanaConnectorProfile; ``` - *Type:* AsanaConnectorProfile --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string --- ### ConnectorProfileProps #### Initializer ```typescript import { ConnectorProfileProps } from '@cdklabs/cdk-appflow' const connectorProfileProps: ConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ### DataPullConfig #### Initializer ```typescript import { DataPullConfig } from '@cdklabs/cdk-appflow' const dataPullConfig: DataPullConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | mode | DataPullMode | *No description.* | | timestampField | string | The name of the field to use as a timestamp for recurring incremental flows. | --- ##### `mode`^Required ```typescript public readonly mode: DataPullMode; ``` - *Type:* DataPullMode --- ##### `timestampField`^Optional ```typescript public readonly timestampField: string; ``` - *Type:* string The name of the field to use as a timestamp for recurring incremental flows. The default field is set per particular > [ISource.](ISource.) --- ### ErrorHandlingConfiguration #### Initializer ```typescript import { ErrorHandlingConfiguration } from '@cdklabs/cdk-appflow' const errorHandlingConfiguration: ErrorHandlingConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | errorLocation | S3Location | *No description.* | | failOnFirstError | boolean | *No description.* | --- ##### `errorLocation`^Optional ```typescript public readonly errorLocation: S3Location; ``` - *Type:* S3Location --- ##### `failOnFirstError`^Optional ```typescript public readonly failOnFirstError: boolean; ``` - *Type:* boolean --- ### EventBridgeDestinationProps The properties for the EventBridge destination. #### Initializer ```typescript import { EventBridgeDestinationProps } from '@cdklabs/cdk-appflow' const eventBridgeDestinationProps: EventBridgeDestinationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | partnerBus | string | *No description.* | | errorHandling | ErrorHandlingConfiguration | *No description.* | --- ##### `partnerBus`^Required ```typescript public readonly partnerBus: string; ``` - *Type:* string --- ##### `errorHandling`^Optional ```typescript public readonly errorHandling: ErrorHandlingConfiguration; ``` - *Type:* ErrorHandlingConfiguration --- ### Field #### Initializer ```typescript import { Field } from '@cdklabs/cdk-appflow' const field: Field = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | *No description.* | | dataType | string | *No description.* | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `dataType`^Optional ```typescript public readonly dataType: string; ``` - *Type:* string --- ### FlowBaseProps #### Initializer ```typescript import { FlowBaseProps } from '@cdklabs/cdk-appflow' const flowBaseProps: FlowBaseProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | destination | IDestination | *No description.* | | mappings | IMapping[] | *No description.* | | source | ISource | *No description.* | | description | string | *No description.* | | filters | IFilter[] | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | name | string | *No description.* | | transforms | ITransform[] | *No description.* | | validations | IValidation[] | *No description.* | | type | FlowType | *No description.* | | status | FlowStatus | *No description.* | | triggerConfig | TriggerConfig | *No description.* | --- ##### `destination`^Required ```typescript public readonly destination: IDestination; ``` - *Type:* IDestination --- ##### `mappings`^Required ```typescript public readonly mappings: IMapping[]; ``` - *Type:* IMapping[] --- ##### `source`^Required ```typescript public readonly source: ISource; ``` - *Type:* ISource --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `filters`^Optional ```typescript public readonly filters: IFilter[]; ``` - *Type:* IFilter[] --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `transforms`^Optional ```typescript public readonly transforms: ITransform[]; ``` - *Type:* ITransform[] --- ##### `validations`^Optional ```typescript public readonly validations: IValidation[]; ``` - *Type:* IValidation[] --- ##### `type`^Required ```typescript public readonly type: FlowType; ``` - *Type:* FlowType --- ##### `status`^Optional ```typescript public readonly status: FlowStatus; ``` - *Type:* FlowStatus --- ##### `triggerConfig`^Optional ```typescript public readonly triggerConfig: TriggerConfig; ``` - *Type:* TriggerConfig --- ### FlowProps #### Initializer ```typescript import { FlowProps } from '@cdklabs/cdk-appflow' const flowProps: FlowProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | destination | IDestination | *No description.* | | mappings | IMapping[] | *No description.* | | source | ISource | *No description.* | | description | string | *No description.* | | filters | IFilter[] | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | name | string | *No description.* | | transforms | ITransform[] | *No description.* | | validations | IValidation[] | *No description.* | --- ##### `destination`^Required ```typescript public readonly destination: IDestination; ``` - *Type:* IDestination --- ##### `mappings`^Required ```typescript public readonly mappings: IMapping[]; ``` - *Type:* IMapping[] --- ##### `source`^Required ```typescript public readonly source: ISource; ``` - *Type:* ISource --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `filters`^Optional ```typescript public readonly filters: IFilter[]; ``` - *Type:* IFilter[] --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `transforms`^Optional ```typescript public readonly transforms: ITransform[]; ``` - *Type:* ITransform[] --- ##### `validations`^Optional ```typescript public readonly validations: IValidation[]; ``` - *Type:* IValidation[] --- ### GoogleAdsConnectorProfileProps #### Initializer ```typescript import { GoogleAdsConnectorProfileProps } from '@cdklabs/cdk-appflow' const googleAdsConnectorProfileProps: GoogleAdsConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | apiVersion | string | *No description.* | | developerToken | aws-cdk-lib.SecretValue | *No description.* | | oAuth | GoogleAdsOAuthSettings | *No description.* | | managerID | aws-cdk-lib.SecretValue | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string --- ##### `developerToken`^Required ```typescript public readonly developerToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `oAuth`^Required ```typescript public readonly oAuth: GoogleAdsOAuthSettings; ``` - *Type:* GoogleAdsOAuthSettings --- ##### `managerID`^Optional ```typescript public readonly managerID: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ### GoogleAdsOAuthEndpoints Google's OAuth token and authorization endpoints. #### Initializer ```typescript import { GoogleAdsOAuthEndpoints } from '@cdklabs/cdk-appflow' const googleAdsOAuthEndpoints: GoogleAdsOAuthEndpoints = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorization | string | The OAuth authorization endpoint URI. | | token | string | The OAuth token endpoint URI. | --- ##### `authorization`^Optional ```typescript public readonly authorization: string; ``` - *Type:* string The OAuth authorization endpoint URI. --- ##### `token`^Optional ```typescript public readonly token: string; ``` - *Type:* string The OAuth token endpoint URI. --- ### GoogleAdsOAuthFlow Represents the OAuth flow enabled for the GoogleAds. #### Initializer ```typescript import { GoogleAdsOAuthFlow } from '@cdklabs/cdk-appflow' const googleAdsOAuthFlow: GoogleAdsOAuthFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | refreshTokenGrant | GoogleAdsRefreshTokenGrantFlow | The details required for executing the refresh token grant flow. | --- ##### `refreshTokenGrant`^Required ```typescript public readonly refreshTokenGrant: GoogleAdsRefreshTokenGrantFlow; ``` - *Type:* GoogleAdsRefreshTokenGrantFlow The details required for executing the refresh token grant flow. --- ### GoogleAdsOAuthSettings #### Initializer ```typescript import { GoogleAdsOAuthSettings } from '@cdklabs/cdk-appflow' const googleAdsOAuthSettings: GoogleAdsOAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessToken | aws-cdk-lib.SecretValue | The access token to be used when interacting with Google Ads. | | endpoints | GoogleAdsOAuthEndpoints | The OAuth token and authorization endpoints. | | flow | GoogleAdsOAuthFlow | The OAuth flow used for obtaining a new accessToken when the old is not present or expired. | --- ##### `accessToken`^Optional ```typescript public readonly accessToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue - *Default:* Retrieves a fresh accessToken with the information in the [flow property]{@link GoogleAdsOAuthSettings#flow } The access token to be used when interacting with Google Ads. Note that if only the access token is provided AppFlow is not able to retrieve a fresh access token when the current one is expired --- ##### `endpoints`^Optional ```typescript public readonly endpoints: GoogleAdsOAuthEndpoints; ``` - *Type:* GoogleAdsOAuthEndpoints The OAuth token and authorization endpoints. --- ##### `flow`^Optional ```typescript public readonly flow: GoogleAdsOAuthFlow; ``` - *Type:* GoogleAdsOAuthFlow - *Default:* undefined. AppFlow will not request any new accessToken after expiry. The OAuth flow used for obtaining a new accessToken when the old is not present or expired. --- ### GoogleAdsRefreshTokenGrantFlow The OAuth elements required for the execution of the refresh token grant flow. #### Initializer ```typescript import { GoogleAdsRefreshTokenGrantFlow } from '@cdklabs/cdk-appflow' const googleAdsRefreshTokenGrantFlow: GoogleAdsRefreshTokenGrantFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | aws-cdk-lib.SecretValue | The id of the client app. | | clientSecret | aws-cdk-lib.SecretValue | The secret of the client app. | | refreshToken | aws-cdk-lib.SecretValue | A non-expired refresh token. | --- ##### `clientId`^Optional ```typescript public readonly clientId: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue The id of the client app. --- ##### `clientSecret`^Optional ```typescript public readonly clientSecret: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue The secret of the client app. --- ##### `refreshToken`^Optional ```typescript public readonly refreshToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue A non-expired refresh token. --- ### GoogleAdsSourceProps Properties of a Google Ads Source. #### Initializer ```typescript import { GoogleAdsSourceProps } from '@cdklabs/cdk-appflow' const googleAdsSourceProps: GoogleAdsSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | *No description.* | | object | string | *No description.* | | profile | GoogleAdsConnectorProfile | *No description.* | --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string --- ##### `object`^Required ```typescript public readonly object: string; ``` - *Type:* string --- ##### `profile`^Required ```typescript public readonly profile: GoogleAdsConnectorProfile; ``` - *Type:* GoogleAdsConnectorProfile --- ### GoogleAnalytics4ConnectorProfileProps #### Initializer ```typescript import { GoogleAnalytics4ConnectorProfileProps } from '@cdklabs/cdk-appflow' const googleAnalytics4ConnectorProfileProps: GoogleAnalytics4ConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | oAuth | GoogleAnalytics4OAuthSettings | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `oAuth`^Required ```typescript public readonly oAuth: GoogleAnalytics4OAuthSettings; ``` - *Type:* GoogleAnalytics4OAuthSettings --- ### GoogleAnalytics4OAuthEndpoints Google's OAuth token and authorization endpoints. #### Initializer ```typescript import { GoogleAnalytics4OAuthEndpoints } from '@cdklabs/cdk-appflow' const googleAnalytics4OAuthEndpoints: GoogleAnalytics4OAuthEndpoints = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorization | string | The OAuth authorization endpoint URI. | | token | string | The OAuth token endpoint URI. | --- ##### `authorization`^Optional ```typescript public readonly authorization: string; ``` - *Type:* string The OAuth authorization endpoint URI. --- ##### `token`^Optional ```typescript public readonly token: string; ``` - *Type:* string The OAuth token endpoint URI. --- ### GoogleAnalytics4OAuthFlow Represents the OAuth flow enabled for the GA4. #### Initializer ```typescript import { GoogleAnalytics4OAuthFlow } from '@cdklabs/cdk-appflow' const googleAnalytics4OAuthFlow: GoogleAnalytics4OAuthFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | refreshTokenGrant | GoogleAnalytics4RefreshTokenGrantFlow | The details required for executing the refresh token grant flow. | --- ##### `refreshTokenGrant`^Required ```typescript public readonly refreshTokenGrant: GoogleAnalytics4RefreshTokenGrantFlow; ``` - *Type:* GoogleAnalytics4RefreshTokenGrantFlow The details required for executing the refresh token grant flow. --- ### GoogleAnalytics4OAuthSettings #### Initializer ```typescript import { GoogleAnalytics4OAuthSettings } from '@cdklabs/cdk-appflow' const googleAnalytics4OAuthSettings: GoogleAnalytics4OAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessToken | aws-cdk-lib.SecretValue | The access token to be used when interacting with Google Analytics 4. | | endpoints | GoogleAnalytics4OAuthEndpoints | The OAuth token and authorization endpoints. | | flow | GoogleAnalytics4OAuthFlow | The OAuth flow used for obtaining a new accessToken when the old is not present or expired. | --- ##### `accessToken`^Optional ```typescript public readonly accessToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue - *Default:* Retrieves a fresh accessToken with the information in the [flow property]{@link GoogleAnalytics4OAuthSettings#flow } The access token to be used when interacting with Google Analytics 4. Note that if only the access token is provided AppFlow is not able to retrieve a fresh access token when the current one is expired --- ##### `endpoints`^Optional ```typescript public readonly endpoints: GoogleAnalytics4OAuthEndpoints; ``` - *Type:* GoogleAnalytics4OAuthEndpoints The OAuth token and authorization endpoints. --- ##### `flow`^Optional ```typescript public readonly flow: GoogleAnalytics4OAuthFlow; ``` - *Type:* GoogleAnalytics4OAuthFlow - *Default:* undefined. AppFlow will not request any new accessToken after expiry. The OAuth flow used for obtaining a new accessToken when the old is not present or expired. --- ### GoogleAnalytics4RefreshTokenGrantFlow The OAuth elements required for the execution of the refresh token grant flow. #### Initializer ```typescript import { GoogleAnalytics4RefreshTokenGrantFlow } from '@cdklabs/cdk-appflow' const googleAnalytics4RefreshTokenGrantFlow: GoogleAnalytics4RefreshTokenGrantFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | aws-cdk-lib.SecretValue | The id of the client app. | | clientSecret | aws-cdk-lib.SecretValue | The secret of the client app. | | refreshToken | aws-cdk-lib.SecretValue | A non-expired refresh token. | --- ##### `clientId`^Optional ```typescript public readonly clientId: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue The id of the client app. --- ##### `clientSecret`^Optional ```typescript public readonly clientSecret: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue The secret of the client app. --- ##### `refreshToken`^Optional ```typescript public readonly refreshToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue A non-expired refresh token. --- ### GoogleAnalytics4SourceProps Properties of a Google Analytics v4 Source. #### Initializer ```typescript import { GoogleAnalytics4SourceProps } from '@cdklabs/cdk-appflow' const googleAnalytics4SourceProps: GoogleAnalytics4SourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | *No description.* | | object | string | *No description.* | | profile | GoogleAnalytics4ConnectorProfile | *No description.* | --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string --- ##### `object`^Required ```typescript public readonly object: string; ``` - *Type:* string --- ##### `profile`^Required ```typescript public readonly profile: GoogleAnalytics4ConnectorProfile; ``` - *Type:* GoogleAnalytics4ConnectorProfile --- ### GoogleBigQueryConnectorProfileProps #### Initializer ```typescript import { GoogleBigQueryConnectorProfileProps } from '@cdklabs/cdk-appflow' const googleBigQueryConnectorProfileProps: GoogleBigQueryConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | oAuth | GoogleBigQueryOAuthSettings | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `oAuth`^Required ```typescript public readonly oAuth: GoogleBigQueryOAuthSettings; ``` - *Type:* GoogleBigQueryOAuthSettings --- ### GoogleBigQueryOAuthEndpoints Google's OAuth token and authorization endpoints. #### Initializer ```typescript import { GoogleBigQueryOAuthEndpoints } from '@cdklabs/cdk-appflow' const googleBigQueryOAuthEndpoints: GoogleBigQueryOAuthEndpoints = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorization | string | The OAuth authorization endpoint URI. | | token | string | The OAuth token endpoint URI. | --- ##### `authorization`^Optional ```typescript public readonly authorization: string; ``` - *Type:* string The OAuth authorization endpoint URI. --- ##### `token`^Optional ```typescript public readonly token: string; ``` - *Type:* string The OAuth token endpoint URI. --- ### GoogleBigQueryOAuthFlow Represents the OAuth flow enabled for the GA4. #### Initializer ```typescript import { GoogleBigQueryOAuthFlow } from '@cdklabs/cdk-appflow' const googleBigQueryOAuthFlow: GoogleBigQueryOAuthFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | refreshTokenGrant | GoogleBigQueryRefreshTokenGrantFlow | The details required for executing the refresh token grant flow. | --- ##### `refreshTokenGrant`^Required ```typescript public readonly refreshTokenGrant: GoogleBigQueryRefreshTokenGrantFlow; ``` - *Type:* GoogleBigQueryRefreshTokenGrantFlow The details required for executing the refresh token grant flow. --- ### GoogleBigQueryOAuthSettings #### Initializer ```typescript import { GoogleBigQueryOAuthSettings } from '@cdklabs/cdk-appflow' const googleBigQueryOAuthSettings: GoogleBigQueryOAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessToken | aws-cdk-lib.SecretValue | The access token to be used when interacting with Google BigQuery. | | endpoints | GoogleBigQueryOAuthEndpoints | The OAuth token and authorization endpoints. | | flow | GoogleBigQueryOAuthFlow | The OAuth flow used for obtaining a new accessToken when the old is not present or expired. | --- ##### `accessToken`^Optional ```typescript public readonly accessToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue - *Default:* Retrieves a fresh accessToken with the information in the [flow property]{@link GoogleBigQueryOAuthSettings#flow } The access token to be used when interacting with Google BigQuery. Note that if only the access token is provided AppFlow is not able to retrieve a fresh access token when the current one is expired --- ##### `endpoints`^Optional ```typescript public readonly endpoints: GoogleBigQueryOAuthEndpoints; ``` - *Type:* GoogleBigQueryOAuthEndpoints The OAuth token and authorization endpoints. --- ##### `flow`^Optional ```typescript public readonly flow: GoogleBigQueryOAuthFlow; ``` - *Type:* GoogleBigQueryOAuthFlow - *Default:* undefined. AppFlow will not request any new accessToken after expiry. The OAuth flow used for obtaining a new accessToken when the old is not present or expired. --- ### GoogleBigQueryObject #### Initializer ```typescript import { GoogleBigQueryObject } from '@cdklabs/cdk-appflow' const googleBigQueryObject: GoogleBigQueryObject = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dataset | string | *No description.* | | project | string | *No description.* | | table | string | *No description.* | --- ##### `dataset`^Required ```typescript public readonly dataset: string; ``` - *Type:* string --- ##### `project`^Required ```typescript public readonly project: string; ``` - *Type:* string --- ##### `table`^Required ```typescript public readonly table: string; ``` - *Type:* string --- ### GoogleBigQueryRefreshTokenGrantFlow The OAuth elements required for the execution of the refresh token grant flow. #### Initializer ```typescript import { GoogleBigQueryRefreshTokenGrantFlow } from '@cdklabs/cdk-appflow' const googleBigQueryRefreshTokenGrantFlow: GoogleBigQueryRefreshTokenGrantFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | aws-cdk-lib.SecretValue | The id of the client app. | | clientSecret | aws-cdk-lib.SecretValue | The secret of the client app. | | refreshToken | aws-cdk-lib.SecretValue | A non-expired refresh token. | --- ##### `clientId`^Optional ```typescript public readonly clientId: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue The id of the client app. --- ##### `clientSecret`^Optional ```typescript public readonly clientSecret: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue The secret of the client app. --- ##### `refreshToken`^Optional ```typescript public readonly refreshToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue A non-expired refresh token. --- ### GoogleBigQuerySourceProps Properties of a Google BigQuery Source. #### Initializer ```typescript import { GoogleBigQuerySourceProps } from '@cdklabs/cdk-appflow' const googleBigQuerySourceProps: GoogleBigQuerySourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | *No description.* | | object | GoogleBigQueryObject | *No description.* | | profile | GoogleBigQueryConnectorProfile | *No description.* | --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string --- ##### `object`^Required ```typescript public readonly object: GoogleBigQueryObject; ``` - *Type:* GoogleBigQueryObject --- ##### `profile`^Required ```typescript public readonly profile: GoogleBigQueryConnectorProfile; ``` - *Type:* GoogleBigQueryConnectorProfile --- ### HubSpotConnectorProfileProps #### Initializer ```typescript import { HubSpotConnectorProfileProps } from '@cdklabs/cdk-appflow' const hubSpotConnectorProfileProps: HubSpotConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | oAuth | HubSpotOAuthSettings | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `oAuth`^Required ```typescript public readonly oAuth: HubSpotOAuthSettings; ``` - *Type:* HubSpotOAuthSettings --- ### HubSpotDestinationProps #### Initializer ```typescript import { HubSpotDestinationProps } from '@cdklabs/cdk-appflow' const hubSpotDestinationProps: HubSpotDestinationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | HubSpotApiVersion | *No description.* | | entity | string[] | *No description.* | | operation | WriteOperation | *No description.* | | profile | HubSpotConnectorProfile | *No description.* | | errorHandling | ErrorHandlingConfiguration | The settings that determine how Amazon AppFlow handles an error when placing data in the HubSpot destination. | --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: HubSpotApiVersion; ``` - *Type:* HubSpotApiVersion --- ##### `entity`^Required ```typescript public readonly entity: string[]; ``` - *Type:* string[] --- ##### `operation`^Required ```typescript public readonly operation: WriteOperation; ``` - *Type:* WriteOperation --- ##### `profile`^Required ```typescript public readonly profile: HubSpotConnectorProfile; ``` - *Type:* HubSpotConnectorProfile --- ##### `errorHandling`^Optional ```typescript public readonly errorHandling: ErrorHandlingConfiguration; ``` - *Type:* ErrorHandlingConfiguration The settings that determine how Amazon AppFlow handles an error when placing data in the HubSpot destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. --- ### HubSpotOAuthEndpoints Hubspot OAuth token and authorization endpoints. #### Initializer ```typescript import { HubSpotOAuthEndpoints } from '@cdklabs/cdk-appflow' const hubSpotOAuthEndpoints: HubSpotOAuthEndpoints = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | token | string | The OAuth token endpoint URI. | --- ##### `token`^Optional ```typescript public readonly token: string; ``` - *Type:* string The OAuth token endpoint URI. --- ### HubSpotOAuthFlow Represents the OAuth flow enabled for the GA4. #### Initializer ```typescript import { HubSpotOAuthFlow } from '@cdklabs/cdk-appflow' const hubSpotOAuthFlow: HubSpotOAuthFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | refreshTokenGrant | HubSpotRefreshTokenGrantFlow | The details required for executing the refresh token grant flow. | --- ##### `refreshTokenGrant`^Required ```typescript public readonly refreshTokenGrant: HubSpotRefreshTokenGrantFlow; ``` - *Type:* HubSpotRefreshTokenGrantFlow The details required for executing the refresh token grant flow. --- ### HubSpotOAuthSettings #### Initializer ```typescript import { HubSpotOAuthSettings } from '@cdklabs/cdk-appflow' const hubSpotOAuthSettings: HubSpotOAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessToken | aws-cdk-lib.SecretValue | The access token to be used when interacting with Hubspot. | | endpoints | HubSpotOAuthEndpoints | The OAuth token and authorization endpoints. | | flow | HubSpotOAuthFlow | The OAuth flow used for obtaining a new accessToken when the old is not present or expired. | --- ##### `accessToken`^Optional ```typescript public readonly accessToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue - *Default:* Retrieves a fresh accessToken with the information in the [flow property]{@link HubSpotOAuthSettings#flow } The access token to be used when interacting with Hubspot. Note that if only the access token is provided AppFlow is not able to retrieve a fresh access token when the current one is expired --- ##### `endpoints`^Optional ```typescript public readonly endpoints: HubSpotOAuthEndpoints; ``` - *Type:* HubSpotOAuthEndpoints The OAuth token and authorization endpoints. --- ##### `flow`^Optional ```typescript public readonly flow: HubSpotOAuthFlow; ``` - *Type:* HubSpotOAuthFlow - *Default:* undefined. AppFlow will not request any new accessToken after expiry. The OAuth flow used for obtaining a new accessToken when the old is not present or expired. --- ### HubSpotRefreshTokenGrantFlow The OAuth elements required for the execution of the refresh token grant flow. #### Initializer ```typescript import { HubSpotRefreshTokenGrantFlow } from '@cdklabs/cdk-appflow' const hubSpotRefreshTokenGrantFlow: HubSpotRefreshTokenGrantFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | aws-cdk-lib.SecretValue | The id of the client app. | | clientSecret | aws-cdk-lib.SecretValue | The secret of the client app. | | refreshToken | aws-cdk-lib.SecretValue | A non-expired refresh token. | --- ##### `clientId`^Optional ```typescript public readonly clientId: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue The id of the client app. --- ##### `clientSecret`^Optional ```typescript public readonly clientSecret: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue The secret of the client app. --- ##### `refreshToken`^Optional ```typescript public readonly refreshToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue A non-expired refresh token. --- ### HubSpotSourceProps Properties of a Hubspot Source. #### Initializer ```typescript import { HubSpotSourceProps } from '@cdklabs/cdk-appflow' const hubSpotSourceProps: HubSpotSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | HubSpotApiVersion | *No description.* | | entity | string[] | *No description.* | | profile | HubSpotConnectorProfile | *No description.* | --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: HubSpotApiVersion; ``` - *Type:* HubSpotApiVersion --- ##### `entity`^Required ```typescript public readonly entity: string[]; ``` - *Type:* string[] --- ##### `profile`^Required ```typescript public readonly profile: HubSpotConnectorProfile; ``` - *Type:* HubSpotConnectorProfile --- ### JdbcSmallDataScaleBasicAuthSettings Basic authentication settings for the JdbcSmallDataScaleConnectorProfile. #### Initializer ```typescript import { JdbcSmallDataScaleBasicAuthSettings } from '@cdklabs/cdk-appflow' const jdbcSmallDataScaleBasicAuthSettings: JdbcSmallDataScaleBasicAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | password | aws-cdk-lib.SecretValue | The password of the identity used for interacting with the database. | | username | string | The username of the identity used for interacting with the database. | --- ##### `password`^Required ```typescript public readonly password: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue The password of the identity used for interacting with the database. --- ##### `username`^Required ```typescript public readonly username: string; ``` - *Type:* string The username of the identity used for interacting with the database. --- ### JdbcSmallDataScaleConnectorProfileProps Properties for the JdbcSmallDataScaleConnectorProfile. #### Initializer ```typescript import { JdbcSmallDataScaleConnectorProfileProps } from '@cdklabs/cdk-appflow' const jdbcSmallDataScaleConnectorProfileProps: JdbcSmallDataScaleConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | basicAuth | JdbcSmallDataScaleBasicAuthSettings | The auth settings for the profile. | | database | string | The name of the database. | | driver | JdbcDriver | The driver for the database. | | hostname | string | The hostname of the database to interact with. | | port | number | The database communication port. | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `basicAuth`^Required ```typescript public readonly basicAuth: JdbcSmallDataScaleBasicAuthSettings; ``` - *Type:* JdbcSmallDataScaleBasicAuthSettings The auth settings for the profile. --- ##### `database`^Required ```typescript public readonly database: string; ``` - *Type:* string The name of the database. --- ##### `driver`^Required ```typescript public readonly driver: JdbcDriver; ``` - *Type:* JdbcDriver The driver for the database. Effectively specifies the type of database. --- ##### `hostname`^Required ```typescript public readonly hostname: string; ``` - *Type:* string The hostname of the database to interact with. --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number The database communication port. --- ### JdbcSmallDataScaleObject #### Initializer ```typescript import { JdbcSmallDataScaleObject } from '@cdklabs/cdk-appflow' const jdbcSmallDataScaleObject: JdbcSmallDataScaleObject = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | schema | string | *No description.* | | table | string | *No description.* | --- ##### `schema`^Required ```typescript public readonly schema: string; ``` - *Type:* string --- ##### `table`^Required ```typescript public readonly table: string; ``` - *Type:* string --- ### JdbcSmallDataScaleSourceProps #### Initializer ```typescript import { JdbcSmallDataScaleSourceProps } from '@cdklabs/cdk-appflow' const jdbcSmallDataScaleSourceProps: JdbcSmallDataScaleSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | object | JdbcSmallDataScaleObject | *No description.* | | profile | JdbcSmallDataScaleConnectorProfile | *No description.* | | apiVersion | string | *No description.* | --- ##### `object`^Required ```typescript public readonly object: JdbcSmallDataScaleObject; ``` - *Type:* JdbcSmallDataScaleObject --- ##### `profile`^Required ```typescript public readonly profile: JdbcSmallDataScaleConnectorProfile; ``` - *Type:* JdbcSmallDataScaleConnectorProfile --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string --- ### MailchimpConnectorProfileProps #### Initializer ```typescript import { MailchimpConnectorProfileProps } from '@cdklabs/cdk-appflow' const mailchimpConnectorProfileProps: MailchimpConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | apiKey | aws-cdk-lib.SecretValue | *No description.* | | instanceUrl | string | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `apiKey`^Required ```typescript public readonly apiKey: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `instanceUrl`^Required ```typescript public readonly instanceUrl: string; ``` - *Type:* string --- ### MailchimpSourceProps #### Initializer ```typescript import { MailchimpSourceProps } from '@cdklabs/cdk-appflow' const mailchimpSourceProps: MailchimpSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | *No description.* | | object | string | *No description.* | | profile | MailchimpConnectorProfile | *No description.* | --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string --- ##### `object`^Required ```typescript public readonly object: string; ``` - *Type:* string --- ##### `profile`^Required ```typescript public readonly profile: MailchimpConnectorProfile; ``` - *Type:* MailchimpConnectorProfile --- ### MapAllConfig A helper interface. #### Initializer ```typescript import { MapAllConfig } from '@cdklabs/cdk-appflow' const mapAllConfig: MapAllConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | exclude | string[] | *No description.* | --- ##### `exclude`^Required ```typescript public readonly exclude: string[]; ``` - *Type:* string[] --- ### MarketoConnectorProfileProps #### Initializer ```typescript import { MarketoConnectorProfileProps } from '@cdklabs/cdk-appflow' const marketoConnectorProfileProps: MarketoConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | instanceUrl | string | *No description.* | | oAuth | MarketoOAuthSettings | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `instanceUrl`^Required ```typescript public readonly instanceUrl: string; ``` - *Type:* string --- ##### `oAuth`^Required ```typescript public readonly oAuth: MarketoOAuthSettings; ``` - *Type:* MarketoOAuthSettings --- ### MarketoOAuthClientCredentialsFlow #### Initializer ```typescript import { MarketoOAuthClientCredentialsFlow } from '@cdklabs/cdk-appflow' const marketoOAuthClientCredentialsFlow: MarketoOAuthClientCredentialsFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | aws-cdk-lib.SecretValue | *No description.* | | clientSecret | aws-cdk-lib.SecretValue | *No description.* | --- ##### `clientId`^Required ```typescript public readonly clientId: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `clientSecret`^Required ```typescript public readonly clientSecret: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ### MarketoOAuthFlow #### Initializer ```typescript import { MarketoOAuthFlow } from '@cdklabs/cdk-appflow' const marketoOAuthFlow: MarketoOAuthFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientCredentials | MarketoOAuthClientCredentialsFlow | *No description.* | --- ##### `clientCredentials`^Required ```typescript public readonly clientCredentials: MarketoOAuthClientCredentialsFlow; ``` - *Type:* MarketoOAuthClientCredentialsFlow --- ### MarketoOAuthSettings #### Initializer ```typescript import { MarketoOAuthSettings } from '@cdklabs/cdk-appflow' const marketoOAuthSettings: MarketoOAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | flow | MarketoOAuthFlow | *No description.* | | accessToken | aws-cdk-lib.SecretValue | *No description.* | --- ##### `flow`^Required ```typescript public readonly flow: MarketoOAuthFlow; ``` - *Type:* MarketoOAuthFlow --- ##### `accessToken`^Optional ```typescript public readonly accessToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ### MarketoSourceProps #### Initializer ```typescript import { MarketoSourceProps } from '@cdklabs/cdk-appflow' const marketoSourceProps: MarketoSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | object | string | *No description.* | | profile | MarketoConnectorProfile | *No description.* | | apiVersion | string | *No description.* | --- ##### `object`^Required ```typescript public readonly object: string; ``` - *Type:* string --- ##### `profile`^Required ```typescript public readonly profile: MarketoConnectorProfile; ``` - *Type:* MarketoConnectorProfile --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string --- ### MicrosoftDynamics365ConnectorProfileProps #### Initializer ```typescript import { MicrosoftDynamics365ConnectorProfileProps } from '@cdklabs/cdk-appflow' const microsoftDynamics365ConnectorProfileProps: MicrosoftDynamics365ConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | instanceUrl | string | *No description.* | | oAuth | MicrosoftDynamics365OAuthSettings | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `instanceUrl`^Required ```typescript public readonly instanceUrl: string; ``` - *Type:* string --- ##### `oAuth`^Required ```typescript public readonly oAuth: MicrosoftDynamics365OAuthSettings; ``` - *Type:* MicrosoftDynamics365OAuthSettings --- ### MicrosoftDynamics365OAuthEndpointsSettings #### Initializer ```typescript import { MicrosoftDynamics365OAuthEndpointsSettings } from '@cdklabs/cdk-appflow' const microsoftDynamics365OAuthEndpointsSettings: MicrosoftDynamics365OAuthEndpointsSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | token | string | *No description.* | --- ##### `token`^Required ```typescript public readonly token: string; ``` - *Type:* string --- ### MicrosoftDynamics365OAuthFlow #### Initializer ```typescript import { MicrosoftDynamics365OAuthFlow } from '@cdklabs/cdk-appflow' const microsoftDynamics365OAuthFlow: MicrosoftDynamics365OAuthFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | refreshTokenGrant | MicrosoftDynamics365RefreshTokenGrantFlow | *No description.* | --- ##### `refreshTokenGrant`^Required ```typescript public readonly refreshTokenGrant: MicrosoftDynamics365RefreshTokenGrantFlow; ``` - *Type:* MicrosoftDynamics365RefreshTokenGrantFlow --- ### MicrosoftDynamics365OAuthSettings #### Initializer ```typescript import { MicrosoftDynamics365OAuthSettings } from '@cdklabs/cdk-appflow' const microsoftDynamics365OAuthSettings: MicrosoftDynamics365OAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessToken | aws-cdk-lib.SecretValue | The access token to be used when interacting with Microsoft Dynamics 365. | | endpoints | MicrosoftDynamics365OAuthEndpointsSettings | *No description.* | | flow | MicrosoftDynamics365OAuthFlow | *No description.* | --- ##### `accessToken`^Optional ```typescript public readonly accessToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue The access token to be used when interacting with Microsoft Dynamics 365. Note that if only the access token is provided AppFlow is not able to retrieve a fresh access token when the current one is expired --- ##### `endpoints`^Optional ```typescript public readonly endpoints: MicrosoftDynamics365OAuthEndpointsSettings; ``` - *Type:* MicrosoftDynamics365OAuthEndpointsSettings --- ##### `flow`^Optional ```typescript public readonly flow: MicrosoftDynamics365OAuthFlow; ``` - *Type:* MicrosoftDynamics365OAuthFlow --- ### MicrosoftDynamics365RefreshTokenGrantFlow #### Initializer ```typescript import { MicrosoftDynamics365RefreshTokenGrantFlow } from '@cdklabs/cdk-appflow' const microsoftDynamics365RefreshTokenGrantFlow: MicrosoftDynamics365RefreshTokenGrantFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | aws-cdk-lib.SecretValue | *No description.* | | clientSecret | aws-cdk-lib.SecretValue | *No description.* | | refreshToken | aws-cdk-lib.SecretValue | *No description.* | --- ##### `clientId`^Optional ```typescript public readonly clientId: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `clientSecret`^Optional ```typescript public readonly clientSecret: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `refreshToken`^Optional ```typescript public readonly refreshToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ### MicrosoftDynamics365SourceProps Properties of a Microsoft Dynamics 365 Source. #### Initializer ```typescript import { MicrosoftDynamics365SourceProps } from '@cdklabs/cdk-appflow' const microsoftDynamics365SourceProps: MicrosoftDynamics365SourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | *No description.* | | object | string | *No description.* | | profile | MicrosoftDynamics365ConnectorProfile | *No description.* | --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string --- ##### `object`^Required ```typescript public readonly object: string; ``` - *Type:* string --- ##### `profile`^Required ```typescript public readonly profile: MicrosoftDynamics365ConnectorProfile; ``` - *Type:* MicrosoftDynamics365ConnectorProfile --- ### MicrosoftSharepointOnlineConnectorProfileProps #### Initializer ```typescript import { MicrosoftSharepointOnlineConnectorProfileProps } from '@cdklabs/cdk-appflow' const microsoftSharepointOnlineConnectorProfileProps: MicrosoftSharepointOnlineConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | oAuth | MicrosoftSharepointOnlineOAuthSettings | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `oAuth`^Required ```typescript public readonly oAuth: MicrosoftSharepointOnlineOAuthSettings; ``` - *Type:* MicrosoftSharepointOnlineOAuthSettings --- ### MicrosoftSharepointOnlineOAuthEndpointsSettings #### Initializer ```typescript import { MicrosoftSharepointOnlineOAuthEndpointsSettings } from '@cdklabs/cdk-appflow' const microsoftSharepointOnlineOAuthEndpointsSettings: MicrosoftSharepointOnlineOAuthEndpointsSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | token | string | *No description.* | --- ##### `token`^Required ```typescript public readonly token: string; ``` - *Type:* string --- ### MicrosoftSharepointOnlineOAuthFlow #### Initializer ```typescript import { MicrosoftSharepointOnlineOAuthFlow } from '@cdklabs/cdk-appflow' const microsoftSharepointOnlineOAuthFlow: MicrosoftSharepointOnlineOAuthFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | refreshTokenGrant | MicrosoftSharepointOnlineRefreshTokenGrantFlow | *No description.* | --- ##### `refreshTokenGrant`^Required ```typescript public readonly refreshTokenGrant: MicrosoftSharepointOnlineRefreshTokenGrantFlow; ``` - *Type:* MicrosoftSharepointOnlineRefreshTokenGrantFlow --- ### MicrosoftSharepointOnlineOAuthSettings #### Initializer ```typescript import { MicrosoftSharepointOnlineOAuthSettings } from '@cdklabs/cdk-appflow' const microsoftSharepointOnlineOAuthSettings: MicrosoftSharepointOnlineOAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessToken | aws-cdk-lib.SecretValue | The access token to be used when interacting with Microsoft Sharepoint Online. | | endpoints | MicrosoftSharepointOnlineOAuthEndpointsSettings | *No description.* | | flow | MicrosoftSharepointOnlineOAuthFlow | *No description.* | --- ##### `accessToken`^Optional ```typescript public readonly accessToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue The access token to be used when interacting with Microsoft Sharepoint Online. Note that if only the access token is provided AppFlow is not able to retrieve a fresh access token when the current one is expired --- ##### `endpoints`^Optional ```typescript public readonly endpoints: MicrosoftSharepointOnlineOAuthEndpointsSettings; ``` - *Type:* MicrosoftSharepointOnlineOAuthEndpointsSettings --- ##### `flow`^Optional ```typescript public readonly flow: MicrosoftSharepointOnlineOAuthFlow; ``` - *Type:* MicrosoftSharepointOnlineOAuthFlow --- ### MicrosoftSharepointOnlineObject Represents a list of Microsoft Sharepoint Online site drives from which to retrieve the documents. #### Initializer ```typescript import { MicrosoftSharepointOnlineObject } from '@cdklabs/cdk-appflow' const microsoftSharepointOnlineObject: MicrosoftSharepointOnlineObject = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | site | string | The Microsoft Sharepoint Online site from which the documents are to be retrieved. | | drives | string[] | An array of Microsoft Sharepoint Online site drives from which the documents are to be retrieved. | | entities | string[] | An array of Microsoft Sharepoint Online site entities from which the documents are to be retrieved. | --- ##### `site`^Required ```typescript public readonly site: string; ``` - *Type:* string The Microsoft Sharepoint Online site from which the documents are to be retrieved. Note: requires full name starting with 'sites/' --- ##### ~~`drives`~~^Optional - *Deprecated:* . This property is deprecated and will be removed in a future release. Use {@link entities } instead ```typescript public readonly drives: string[]; ``` - *Type:* string[] An array of Microsoft Sharepoint Online site drives from which the documents are to be retrieved. Note: each drive requires full name starting with 'drives/' --- ##### `entities`^Optional ```typescript public readonly entities: string[]; ``` - *Type:* string[] An array of Microsoft Sharepoint Online site entities from which the documents are to be retrieved. Note: each entity requires full name starting with 'drives/' followed by driveID and optional '/items/' followed by itemID --- *Example* ```typescript : 'drives/${driveID}/items/${itemID}' ``` ### MicrosoftSharepointOnlineRefreshTokenGrantFlow #### Initializer ```typescript import { MicrosoftSharepointOnlineRefreshTokenGrantFlow } from '@cdklabs/cdk-appflow' const microsoftSharepointOnlineRefreshTokenGrantFlow: MicrosoftSharepointOnlineRefreshTokenGrantFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | aws-cdk-lib.SecretValue | *No description.* | | clientSecret | aws-cdk-lib.SecretValue | *No description.* | | refreshToken | aws-cdk-lib.SecretValue | *No description.* | --- ##### `clientId`^Optional ```typescript public readonly clientId: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `clientSecret`^Optional ```typescript public readonly clientSecret: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `refreshToken`^Optional ```typescript public readonly refreshToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ### MicrosoftSharepointOnlineSourceProps Properties of a Microsoft Sharepoint Online Source. #### Initializer ```typescript import { MicrosoftSharepointOnlineSourceProps } from '@cdklabs/cdk-appflow' const microsoftSharepointOnlineSourceProps: MicrosoftSharepointOnlineSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | *No description.* | | object | MicrosoftSharepointOnlineObject | *No description.* | | profile | MicrosoftSharepointOnlineConnectorProfile | *No description.* | --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string --- ##### `object`^Required ```typescript public readonly object: MicrosoftSharepointOnlineObject; ``` - *Type:* MicrosoftSharepointOnlineObject --- ##### `profile`^Required ```typescript public readonly profile: MicrosoftSharepointOnlineConnectorProfile; ``` - *Type:* MicrosoftSharepointOnlineConnectorProfile --- ### OnDemandFlowProps #### Initializer ```typescript import { OnDemandFlowProps } from '@cdklabs/cdk-appflow' const onDemandFlowProps: OnDemandFlowProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | destination | IDestination | *No description.* | | mappings | IMapping[] | *No description.* | | source | ISource | *No description.* | | description | string | *No description.* | | filters | IFilter[] | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | name | string | *No description.* | | transforms | ITransform[] | *No description.* | | validations | IValidation[] | *No description.* | --- ##### `destination`^Required ```typescript public readonly destination: IDestination; ``` - *Type:* IDestination --- ##### `mappings`^Required ```typescript public readonly mappings: IMapping[]; ``` - *Type:* IMapping[] --- ##### `source`^Required ```typescript public readonly source: ISource; ``` - *Type:* ISource --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `filters`^Optional ```typescript public readonly filters: IFilter[]; ``` - *Type:* IFilter[] --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `transforms`^Optional ```typescript public readonly transforms: ITransform[]; ``` - *Type:* ITransform[] --- ##### `validations`^Optional ```typescript public readonly validations: IValidation[]; ``` - *Type:* IValidation[] --- ### OnEventFlowProps #### Initializer ```typescript import { OnEventFlowProps } from '@cdklabs/cdk-appflow' const onEventFlowProps: OnEventFlowProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | destination | IDestination | *No description.* | | mappings | IMapping[] | *No description.* | | source | ISource | *No description.* | | description | string | *No description.* | | filters | IFilter[] | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | name | string | *No description.* | | transforms | ITransform[] | *No description.* | | validations | IValidation[] | *No description.* | | autoActivate | boolean | *No description.* | | status | FlowStatus | The status to set on the flow. | --- ##### `destination`^Required ```typescript public readonly destination: IDestination; ``` - *Type:* IDestination --- ##### `mappings`^Required ```typescript public readonly mappings: IMapping[]; ``` - *Type:* IMapping[] --- ##### `source`^Required ```typescript public readonly source: ISource; ``` - *Type:* ISource --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `filters`^Optional ```typescript public readonly filters: IFilter[]; ``` - *Type:* IFilter[] --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `transforms`^Optional ```typescript public readonly transforms: ITransform[]; ``` - *Type:* ITransform[] --- ##### `validations`^Optional ```typescript public readonly validations: IValidation[]; ``` - *Type:* IValidation[] --- ##### ~~`autoActivate`~~^Optional - *Deprecated:* . This property is deprecated and will be removed in a future release. Use {@link status } instead ```typescript public readonly autoActivate: boolean; ``` - *Type:* boolean --- ##### `status`^Optional ```typescript public readonly status: FlowStatus; ``` - *Type:* FlowStatus The status to set on the flow. Use this over {@link autoActivate}. --- ### OnScheduleFlowProps #### Initializer ```typescript import { OnScheduleFlowProps } from '@cdklabs/cdk-appflow' const onScheduleFlowProps: OnScheduleFlowProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | destination | IDestination | *No description.* | | mappings | IMapping[] | *No description.* | | source | ISource | *No description.* | | description | string | *No description.* | | filters | IFilter[] | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | name | string | *No description.* | | transforms | ITransform[] | *No description.* | | validations | IValidation[] | *No description.* | | autoActivate | boolean | *No description.* | | status | FlowStatus | The status to set on the flow. | | pullConfig | DataPullConfig | *No description.* | | schedule | aws-cdk-lib.aws_events.Schedule | *No description.* | | scheduleProperties | ScheduleProperties | *No description.* | --- ##### `destination`^Required ```typescript public readonly destination: IDestination; ``` - *Type:* IDestination --- ##### `mappings`^Required ```typescript public readonly mappings: IMapping[]; ``` - *Type:* IMapping[] --- ##### `source`^Required ```typescript public readonly source: ISource; ``` - *Type:* ISource --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `filters`^Optional ```typescript public readonly filters: IFilter[]; ``` - *Type:* IFilter[] --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `transforms`^Optional ```typescript public readonly transforms: ITransform[]; ``` - *Type:* ITransform[] --- ##### `validations`^Optional ```typescript public readonly validations: IValidation[]; ``` - *Type:* IValidation[] --- ##### ~~`autoActivate`~~^Optional - *Deprecated:* . This property is deprecated and will be removed in a future release. Use {@link status } instead ```typescript public readonly autoActivate: boolean; ``` - *Type:* boolean --- ##### `status`^Optional ```typescript public readonly status: FlowStatus; ``` - *Type:* FlowStatus The status to set on the flow. Use this over {@link autoActivate}. --- ##### `pullConfig`^Required ```typescript public readonly pullConfig: DataPullConfig; ``` - *Type:* DataPullConfig --- ##### `schedule`^Required ```typescript public readonly schedule: Schedule; ``` - *Type:* aws-cdk-lib.aws_events.Schedule --- ##### `scheduleProperties`^Optional ```typescript public readonly scheduleProperties: ScheduleProperties; ``` - *Type:* ScheduleProperties --- ### RedshiftConnectorBasicCredentials #### Initializer ```typescript import { RedshiftConnectorBasicCredentials } from '@cdklabs/cdk-appflow' const redshiftConnectorBasicCredentials: RedshiftConnectorBasicCredentials = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | password | aws-cdk-lib.SecretValue | *No description.* | | username | string | *No description.* | --- ##### `password`^Optional ```typescript public readonly password: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `username`^Optional ```typescript public readonly username: string; ``` - *Type:* string --- ### RedshiftConnectorProfileProps #### Initializer ```typescript import { RedshiftConnectorProfileProps } from '@cdklabs/cdk-appflow' const redshiftConnectorProfileProps: RedshiftConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | basicAuth | RedshiftConnectorBasicCredentials | *No description.* | | cluster | @aws-cdk/aws-redshift-alpha.ICluster | The Redshift cluster to use this connector profile with. | | databaseName | string | The name of the database which the RedshiftConnectorProfile will be working with. | | intermediateLocation | S3Location | An intermediate location for the data retrieved from the flow source that will be further transferred to the Redshfit database. | | bucketAccessRole | aws-cdk-lib.aws_iam.IRole | An IAM Role that the Redshift cluster will assume to get data from the intermiediate S3 Bucket. | | dataApiRole | aws-cdk-lib.aws_iam.IRole | An IAM Role that AppFlow will assume to interact with the Redshift cluster's Data API. | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `basicAuth`^Required ```typescript public readonly basicAuth: RedshiftConnectorBasicCredentials; ``` - *Type:* RedshiftConnectorBasicCredentials --- ##### `cluster`^Required ```typescript public readonly cluster: ICluster; ``` - *Type:* @aws-cdk/aws-redshift-alpha.ICluster The Redshift cluster to use this connector profile with. --- ##### `databaseName`^Required ```typescript public readonly databaseName: string; ``` - *Type:* string The name of the database which the RedshiftConnectorProfile will be working with. --- ##### `intermediateLocation`^Required ```typescript public readonly intermediateLocation: S3Location; ``` - *Type:* S3Location An intermediate location for the data retrieved from the flow source that will be further transferred to the Redshfit database. --- ##### `bucketAccessRole`^Optional ```typescript public readonly bucketAccessRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole An IAM Role that the Redshift cluster will assume to get data from the intermiediate S3 Bucket. --- ##### `dataApiRole`^Optional ```typescript public readonly dataApiRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* autogenerated IAM role An IAM Role that AppFlow will assume to interact with the Redshift cluster's Data API. --- ### RedshiftDestinationObject #### Initializer ```typescript import { RedshiftDestinationObject } from '@cdklabs/cdk-appflow' const redshiftDestinationObject: RedshiftDestinationObject = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | table | string \| @aws-cdk/aws-redshift-alpha.ITable | *No description.* | | schema | string | *No description.* | --- ##### `table`^Required ```typescript public readonly table: string | ITable; ``` - *Type:* string | @aws-cdk/aws-redshift-alpha.ITable --- ##### `schema`^Optional ```typescript public readonly schema: string; ``` - *Type:* string - *Default:* public --- ### RedshiftDestinationProps #### Initializer ```typescript import { RedshiftDestinationProps } from '@cdklabs/cdk-appflow' const redshiftDestinationProps: RedshiftDestinationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | object | RedshiftDestinationObject | A Redshift table object (optionally with the schema). | | profile | RedshiftConnectorProfile | An instance of the. | | errorHandling | ErrorHandlingConfiguration | The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. | --- ##### `object`^Required ```typescript public readonly object: RedshiftDestinationObject; ``` - *Type:* RedshiftDestinationObject A Redshift table object (optionally with the schema). --- ##### `profile`^Required ```typescript public readonly profile: RedshiftConnectorProfile; ``` - *Type:* RedshiftConnectorProfile An instance of the. --- ##### `errorHandling`^Optional ```typescript public readonly errorHandling: ErrorHandlingConfiguration; ``` - *Type:* ErrorHandlingConfiguration The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. --- ### S3Catalog #### Initializer ```typescript import { S3Catalog } from '@cdklabs/cdk-appflow' const s3Catalog: S3Catalog = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | database | @aws-cdk/aws-glue-alpha.IDatabase | The AWS Glue database that will contain the tables created when the flow executes. | | tablePrefix | string | The prefix for the tables created in the AWS Glue database. | | role | aws-cdk-lib.aws_iam.IRole | The IAM Role that will be used for data catalog operations. | --- ##### `database`^Required ```typescript public readonly database: IDatabase; ``` - *Type:* @aws-cdk/aws-glue-alpha.IDatabase The AWS Glue database that will contain the tables created when the flow executes. --- ##### `tablePrefix`^Required ```typescript public readonly tablePrefix: string; ``` - *Type:* string The prefix for the tables created in the AWS Glue database. --- ##### `role`^Optional ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A new role will be created The IAM Role that will be used for data catalog operations. --- ### S3DestinationProps #### Initializer ```typescript import { S3DestinationProps } from '@cdklabs/cdk-appflow' const s3DestinationProps: S3DestinationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | location | S3Location | The S3 location of the files with the retrieved data. | | catalog | S3Catalog | The AWS Glue cataloging options. | | formatting | S3OutputFormatting | The formatting options for the output files. | --- ##### `location`^Required ```typescript public readonly location: S3Location; ``` - *Type:* S3Location The S3 location of the files with the retrieved data. --- ##### `catalog`^Optional ```typescript public readonly catalog: S3Catalog; ``` - *Type:* S3Catalog The AWS Glue cataloging options. --- ##### `formatting`^Optional ```typescript public readonly formatting: S3OutputFormatting; ``` - *Type:* S3OutputFormatting The formatting options for the output files. --- ### S3FileAggregation #### Initializer ```typescript import { S3FileAggregation } from '@cdklabs/cdk-appflow' const s3FileAggregation: S3FileAggregation = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fileSize | number | The maximum size, in MB, of the file containing portion of incoming data. | | type | S3OutputAggregationType | *No description.* | --- ##### `fileSize`^Optional ```typescript public readonly fileSize: number; ``` - *Type:* number The maximum size, in MB, of the file containing portion of incoming data. --- ##### `type`^Optional ```typescript public readonly type: S3OutputAggregationType; ``` - *Type:* S3OutputAggregationType --- ### S3InputFormat #### Initializer ```typescript import { S3InputFormat } from '@cdklabs/cdk-appflow' const s3InputFormat: S3InputFormat = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | S3InputFileType | *No description.* | --- ##### `type`^Required ```typescript public readonly type: S3InputFileType; ``` - *Type:* S3InputFileType --- ### S3Location #### Initializer ```typescript import { S3Location } from '@cdklabs/cdk-appflow' const s3Location: S3Location = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | | prefix | string | *No description.* | --- ##### `bucket`^Required ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ##### `prefix`^Optional ```typescript public readonly prefix: string; ``` - *Type:* string --- ### S3OutputFilePrefix #### Initializer ```typescript import { S3OutputFilePrefix } from '@cdklabs/cdk-appflow' const s3OutputFilePrefix: S3OutputFilePrefix = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | format | S3OutputFilePrefixFormat | *No description.* | | hierarchy | S3OutputFilePrefixHierarchy[] | *No description.* | | type | S3OutputFilePrefixType | *No description.* | --- ##### `format`^Optional ```typescript public readonly format: S3OutputFilePrefixFormat; ``` - *Type:* S3OutputFilePrefixFormat --- ##### `hierarchy`^Optional ```typescript public readonly hierarchy: S3OutputFilePrefixHierarchy[]; ``` - *Type:* S3OutputFilePrefixHierarchy[] --- ##### `type`^Optional ```typescript public readonly type: S3OutputFilePrefixType; ``` - *Type:* S3OutputFilePrefixType --- ### S3OutputFormatting #### Initializer ```typescript import { S3OutputFormatting } from '@cdklabs/cdk-appflow' const s3OutputFormatting: S3OutputFormatting = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | aggregation | S3FileAggregation | Sets an aggregation approach per flow run. | | filePrefix | S3OutputFilePrefix | Sets a prefix approach for files generated during a flow execution. | | fileType | S3OutputFileType | Sets the file type for the output files. | | preserveSourceDataTypes | boolean | Specifies whether AppFlow should attempt data type mapping from source when the destination output file type is Parquet. | --- ##### `aggregation`^Optional ```typescript public readonly aggregation: S3FileAggregation; ``` - *Type:* S3FileAggregation Sets an aggregation approach per flow run. --- ##### `filePrefix`^Optional ```typescript public readonly filePrefix: S3OutputFilePrefix; ``` - *Type:* S3OutputFilePrefix Sets a prefix approach for files generated during a flow execution. --- ##### `fileType`^Optional ```typescript public readonly fileType: S3OutputFileType; ``` - *Type:* S3OutputFileType - *Default:* JSON file type Sets the file type for the output files. --- ##### `preserveSourceDataTypes`^Optional ```typescript public readonly preserveSourceDataTypes: boolean; ``` - *Type:* boolean - *Default:* do not preserve source data files Specifies whether AppFlow should attempt data type mapping from source when the destination output file type is Parquet. --- ### S3SourceProps #### Initializer ```typescript import { S3SourceProps } from '@cdklabs/cdk-appflow' const s3SourceProps: S3SourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | | prefix | string | *No description.* | | format | S3InputFormat | *No description.* | --- ##### `bucket`^Required ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ##### `prefix`^Required ```typescript public readonly prefix: string; ``` - *Type:* string --- ##### `format`^Optional ```typescript public readonly format: S3InputFormat; ``` - *Type:* S3InputFormat --- ### SalesforceConnectorProfileProps #### Initializer ```typescript import { SalesforceConnectorProfileProps } from '@cdklabs/cdk-appflow' const salesforceConnectorProfileProps: SalesforceConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | instanceUrl | string | *No description.* | | oAuth | SalesforceOAuthSettings | *No description.* | | isSandbox | boolean | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `instanceUrl`^Required ```typescript public readonly instanceUrl: string; ``` - *Type:* string --- ##### `oAuth`^Required ```typescript public readonly oAuth: SalesforceOAuthSettings; ``` - *Type:* SalesforceOAuthSettings --- ##### `isSandbox`^Optional ```typescript public readonly isSandbox: boolean; ``` - *Type:* boolean - *Default:* false --- ### SalesforceDestinationProps #### Initializer ```typescript import { SalesforceDestinationProps } from '@cdklabs/cdk-appflow' const salesforceDestinationProps: SalesforceDestinationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | object | string | The Salesforce object for which the operation is to be set. | | operation | WriteOperation | *No description.* | | profile | SalesforceConnectorProfile | *No description.* | | dataTransferApi | SalesforceDataTransferApi | Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce. | | errorHandling | ErrorHandlingConfiguration | The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. | --- ##### `object`^Required ```typescript public readonly object: string; ``` - *Type:* string The Salesforce object for which the operation is to be set. --- ##### `operation`^Required ```typescript public readonly operation: WriteOperation; ``` - *Type:* WriteOperation --- ##### `profile`^Required ```typescript public readonly profile: SalesforceConnectorProfile; ``` - *Type:* SalesforceConnectorProfile --- ##### `dataTransferApi`^Optional ```typescript public readonly dataTransferApi: SalesforceDataTransferApi; ``` - *Type:* SalesforceDataTransferApi Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce. --- ##### `errorHandling`^Optional ```typescript public readonly errorHandling: ErrorHandlingConfiguration; ``` - *Type:* ErrorHandlingConfiguration The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. --- ### SalesforceMarketingCloudConnectorProfileProps #### Initializer ```typescript import { SalesforceMarketingCloudConnectorProfileProps } from '@cdklabs/cdk-appflow' const salesforceMarketingCloudConnectorProfileProps: SalesforceMarketingCloudConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | instanceUrl | string | *No description.* | | oAuth | SalesforceMarketingCloudOAuthSettings | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `instanceUrl`^Required ```typescript public readonly instanceUrl: string; ``` - *Type:* string --- ##### `oAuth`^Required ```typescript public readonly oAuth: SalesforceMarketingCloudOAuthSettings; ``` - *Type:* SalesforceMarketingCloudOAuthSettings --- ### SalesforceMarketingCloudFlowSettings #### Initializer ```typescript import { SalesforceMarketingCloudFlowSettings } from '@cdklabs/cdk-appflow' const salesforceMarketingCloudFlowSettings: SalesforceMarketingCloudFlowSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientCredentials | SalesforceMarketingCloudOAuthClientSettings | *No description.* | --- ##### `clientCredentials`^Required ```typescript public readonly clientCredentials: SalesforceMarketingCloudOAuthClientSettings; ``` - *Type:* SalesforceMarketingCloudOAuthClientSettings --- ### SalesforceMarketingCloudOAuthClientSettings #### Initializer ```typescript import { SalesforceMarketingCloudOAuthClientSettings } from '@cdklabs/cdk-appflow' const salesforceMarketingCloudOAuthClientSettings: SalesforceMarketingCloudOAuthClientSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | aws-cdk-lib.SecretValue | *No description.* | | clientSecret | aws-cdk-lib.SecretValue | *No description.* | --- ##### `clientId`^Required ```typescript public readonly clientId: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `clientSecret`^Required ```typescript public readonly clientSecret: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ### SalesforceMarketingCloudOAuthEndpoints #### Initializer ```typescript import { SalesforceMarketingCloudOAuthEndpoints } from '@cdklabs/cdk-appflow' const salesforceMarketingCloudOAuthEndpoints: SalesforceMarketingCloudOAuthEndpoints = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | token | string | *No description.* | --- ##### `token`^Required ```typescript public readonly token: string; ``` - *Type:* string --- ### SalesforceMarketingCloudOAuthSettings #### Initializer ```typescript import { SalesforceMarketingCloudOAuthSettings } from '@cdklabs/cdk-appflow' const salesforceMarketingCloudOAuthSettings: SalesforceMarketingCloudOAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endpoints | SalesforceMarketingCloudOAuthEndpoints | *No description.* | | accessToken | aws-cdk-lib.SecretValue | *No description.* | | flow | SalesforceMarketingCloudFlowSettings | *No description.* | --- ##### `endpoints`^Required ```typescript public readonly endpoints: SalesforceMarketingCloudOAuthEndpoints; ``` - *Type:* SalesforceMarketingCloudOAuthEndpoints --- ##### `accessToken`^Optional ```typescript public readonly accessToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `flow`^Optional ```typescript public readonly flow: SalesforceMarketingCloudFlowSettings; ``` - *Type:* SalesforceMarketingCloudFlowSettings --- ### SalesforceMarketingCloudSourceProps Properties of a Salesforce Marketing Cloud Source. #### Initializer ```typescript import { SalesforceMarketingCloudSourceProps } from '@cdklabs/cdk-appflow' const salesforceMarketingCloudSourceProps: SalesforceMarketingCloudSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | *No description.* | | object | string | *No description.* | | profile | SalesforceMarketingCloudConnectorProfile | *No description.* | --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string --- ##### `object`^Required ```typescript public readonly object: string; ``` - *Type:* string --- ##### `profile`^Required ```typescript public readonly profile: SalesforceMarketingCloudConnectorProfile; ``` - *Type:* SalesforceMarketingCloudConnectorProfile --- ### SalesforceOAuthFlow #### Initializer ```typescript import { SalesforceOAuthFlow } from '@cdklabs/cdk-appflow' const salesforceOAuthFlow: SalesforceOAuthFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | refreshTokenGrant | SalesforceOAuthRefreshTokenGrantFlow | The parameters required for the refresh token grant OAuth flow. | --- ##### `refreshTokenGrant`^Optional ```typescript public readonly refreshTokenGrant: SalesforceOAuthRefreshTokenGrantFlow; ``` - *Type:* SalesforceOAuthRefreshTokenGrantFlow The parameters required for the refresh token grant OAuth flow. --- ### SalesforceOAuthRefreshTokenGrantFlow #### Initializer ```typescript import { SalesforceOAuthRefreshTokenGrantFlow } from '@cdklabs/cdk-appflow' const salesforceOAuthRefreshTokenGrantFlow: SalesforceOAuthRefreshTokenGrantFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | client | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | | refreshToken | aws-cdk-lib.SecretValue | *No description.* | --- ##### `client`^Optional ```typescript public readonly client: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ##### `refreshToken`^Optional ```typescript public readonly refreshToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ### SalesforceOAuthSettings #### Initializer ```typescript import { SalesforceOAuthSettings } from '@cdklabs/cdk-appflow' const salesforceOAuthSettings: SalesforceOAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessToken | aws-cdk-lib.SecretValue | *No description.* | | flow | SalesforceOAuthFlow | *No description.* | --- ##### `accessToken`^Optional ```typescript public readonly accessToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `flow`^Optional ```typescript public readonly flow: SalesforceOAuthFlow; ``` - *Type:* SalesforceOAuthFlow --- ### SalesforceSourceProps #### Initializer ```typescript import { SalesforceSourceProps } from '@cdklabs/cdk-appflow' const salesforceSourceProps: SalesforceSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | object | string | *No description.* | | profile | SalesforceConnectorProfile | *No description.* | | apiVersion | string | *No description.* | | dataTransferApi | SalesforceDataTransferApi | Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce. | | enableDynamicFieldUpdate | boolean | *No description.* | | includeDeletedRecords | boolean | *No description.* | --- ##### `object`^Required ```typescript public readonly object: string; ``` - *Type:* string --- ##### `profile`^Required ```typescript public readonly profile: SalesforceConnectorProfile; ``` - *Type:* SalesforceConnectorProfile --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string --- ##### `dataTransferApi`^Optional ```typescript public readonly dataTransferApi: SalesforceDataTransferApi; ``` - *Type:* SalesforceDataTransferApi Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce. --- ##### `enableDynamicFieldUpdate`^Optional ```typescript public readonly enableDynamicFieldUpdate: boolean; ``` - *Type:* boolean --- ##### `includeDeletedRecords`^Optional ```typescript public readonly includeDeletedRecords: boolean; ``` - *Type:* boolean --- ### SAPOdataBasicAuthSettings #### Initializer ```typescript import { SAPOdataBasicAuthSettings } from '@cdklabs/cdk-appflow' const sAPOdataBasicAuthSettings: SAPOdataBasicAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | password | aws-cdk-lib.SecretValue | *No description.* | | username | string | *No description.* | --- ##### `password`^Required ```typescript public readonly password: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `username`^Required ```typescript public readonly username: string; ``` - *Type:* string --- ### SAPOdataConnectorProfileProps #### Initializer ```typescript import { SAPOdataConnectorProfileProps } from '@cdklabs/cdk-appflow' const sAPOdataConnectorProfileProps: SAPOdataConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | applicationHostUrl | string | *No description.* | | applicationServicePath | string | *No description.* | | clientNumber | string | *No description.* | | logonLanguage | string | *No description.* | | basicAuth | SAPOdataBasicAuthSettings | *No description.* | | oAuth | SAPOdataOAuthSettings | *No description.* | | portNumber | number | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `applicationHostUrl`^Required ```typescript public readonly applicationHostUrl: string; ``` - *Type:* string --- ##### `applicationServicePath`^Required ```typescript public readonly applicationServicePath: string; ``` - *Type:* string --- ##### `clientNumber`^Required ```typescript public readonly clientNumber: string; ``` - *Type:* string --- ##### `logonLanguage`^Required ```typescript public readonly logonLanguage: string; ``` - *Type:* string --- ##### `basicAuth`^Optional ```typescript public readonly basicAuth: SAPOdataBasicAuthSettings; ``` - *Type:* SAPOdataBasicAuthSettings --- ##### `oAuth`^Optional ```typescript public readonly oAuth: SAPOdataOAuthSettings; ``` - *Type:* SAPOdataOAuthSettings --- ##### `portNumber`^Optional ```typescript public readonly portNumber: number; ``` - *Type:* number --- ### SAPOdataDestinationProps #### Initializer ```typescript import { SAPOdataDestinationProps } from '@cdklabs/cdk-appflow' const sAPOdataDestinationProps: SAPOdataDestinationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | object | string | The SAPOdata object for which the operation is to be set. | | operation | WriteOperation | *No description.* | | profile | SAPOdataConnectorProfile | *No description.* | | errorHandling | ErrorHandlingConfiguration | The settings that determine how Amazon AppFlow handles an error when placing data in the SAPOdata destination. | | successResponseHandling | SAPOdataSuccessResponseHandlingConfiguration | *No description.* | --- ##### `object`^Required ```typescript public readonly object: string; ``` - *Type:* string The SAPOdata object for which the operation is to be set. --- ##### `operation`^Required ```typescript public readonly operation: WriteOperation; ``` - *Type:* WriteOperation --- ##### `profile`^Required ```typescript public readonly profile: SAPOdataConnectorProfile; ``` - *Type:* SAPOdataConnectorProfile --- ##### `errorHandling`^Optional ```typescript public readonly errorHandling: ErrorHandlingConfiguration; ``` - *Type:* ErrorHandlingConfiguration The settings that determine how Amazon AppFlow handles an error when placing data in the SAPOdata destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. --- ##### `successResponseHandling`^Optional ```typescript public readonly successResponseHandling: SAPOdataSuccessResponseHandlingConfiguration; ``` - *Type:* SAPOdataSuccessResponseHandlingConfiguration --- ### SAPOdataOAuthEndpoints #### Initializer ```typescript import { SAPOdataOAuthEndpoints } from '@cdklabs/cdk-appflow' const sAPOdataOAuthEndpoints: SAPOdataOAuthEndpoints = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | token | string | *No description.* | --- ##### `token`^Required ```typescript public readonly token: string; ``` - *Type:* string --- ### SAPOdataOAuthFlows #### Initializer ```typescript import { SAPOdataOAuthFlows } from '@cdklabs/cdk-appflow' const sAPOdataOAuthFlows: SAPOdataOAuthFlows = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | refreshTokenGrant | SAPOdataOAuthRefreshTokenGrantFlow | *No description.* | --- ##### `refreshTokenGrant`^Required ```typescript public readonly refreshTokenGrant: SAPOdataOAuthRefreshTokenGrantFlow; ``` - *Type:* SAPOdataOAuthRefreshTokenGrantFlow --- ### SAPOdataOAuthRefreshTokenGrantFlow #### Initializer ```typescript import { SAPOdataOAuthRefreshTokenGrantFlow } from '@cdklabs/cdk-appflow' const sAPOdataOAuthRefreshTokenGrantFlow: SAPOdataOAuthRefreshTokenGrantFlow = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | aws-cdk-lib.SecretValue | *No description.* | | clientSecret | aws-cdk-lib.SecretValue | *No description.* | | refreshToken | aws-cdk-lib.SecretValue | *No description.* | --- ##### `clientId`^Required ```typescript public readonly clientId: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `clientSecret`^Required ```typescript public readonly clientSecret: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `refreshToken`^Optional ```typescript public readonly refreshToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ### SAPOdataOAuthSettings #### Initializer ```typescript import { SAPOdataOAuthSettings } from '@cdklabs/cdk-appflow' const sAPOdataOAuthSettings: SAPOdataOAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessToken | aws-cdk-lib.SecretValue | *No description.* | | endpoints | SAPOdataOAuthEndpoints | *No description.* | | flow | SAPOdataOAuthFlows | *No description.* | --- ##### `accessToken`^Optional ```typescript public readonly accessToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `endpoints`^Optional ```typescript public readonly endpoints: SAPOdataOAuthEndpoints; ``` - *Type:* SAPOdataOAuthEndpoints --- ##### `flow`^Optional ```typescript public readonly flow: SAPOdataOAuthFlows; ``` - *Type:* SAPOdataOAuthFlows --- ### SAPOdataSourceProps #### Initializer ```typescript import { SAPOdataSourceProps } from '@cdklabs/cdk-appflow' const sAPOdataSourceProps: SAPOdataSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | object | string | *No description.* | | profile | SAPOdataConnectorProfile | *No description.* | --- ##### `object`^Required ```typescript public readonly object: string; ``` - *Type:* string --- ##### `profile`^Required ```typescript public readonly profile: SAPOdataConnectorProfile; ``` - *Type:* SAPOdataConnectorProfile --- ### SAPOdataSuccessResponseHandlingConfiguration #### Initializer ```typescript import { SAPOdataSuccessResponseHandlingConfiguration } from '@cdklabs/cdk-appflow' const sAPOdataSuccessResponseHandlingConfiguration: SAPOdataSuccessResponseHandlingConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | location | S3Location | *No description.* | --- ##### `location`^Required ```typescript public readonly location: S3Location; ``` - *Type:* S3Location --- ### ScheduleProperties #### Initializer ```typescript import { ScheduleProperties } from '@cdklabs/cdk-appflow' const scheduleProperties: ScheduleProperties = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endTime | Date | *No description.* | | firstExecutionFrom | Date | Timestamp for the records to import from the connector in the first flow run. | | offset | aws-cdk-lib.Duration | *No description.* | | startTime | Date | *No description.* | --- ##### `endTime`^Optional ```typescript public readonly endTime: Date; ``` - *Type:* Date --- ##### `firstExecutionFrom`^Optional ```typescript public readonly firstExecutionFrom: Date; ``` - *Type:* Date - *Default:* 30 days back from the initial frow run Timestamp for the records to import from the connector in the first flow run. --- ##### `offset`^Optional ```typescript public readonly offset: Duration; ``` - *Type:* aws-cdk-lib.Duration --- ##### `startTime`^Optional ```typescript public readonly startTime: Date; ``` - *Type:* Date --- ### ServiceNowBasicSettings #### Initializer ```typescript import { ServiceNowBasicSettings } from '@cdklabs/cdk-appflow' const serviceNowBasicSettings: ServiceNowBasicSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | password | aws-cdk-lib.SecretValue | *No description.* | | username | string | *No description.* | --- ##### `password`^Required ```typescript public readonly password: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `username`^Required ```typescript public readonly username: string; ``` - *Type:* string --- ### ServiceNowConnectorProfileProps #### Initializer ```typescript import { ServiceNowConnectorProfileProps } from '@cdklabs/cdk-appflow' const serviceNowConnectorProfileProps: ServiceNowConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | basicAuth | ServiceNowBasicSettings | *No description.* | | instanceUrl | string | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `basicAuth`^Required ```typescript public readonly basicAuth: ServiceNowBasicSettings; ``` - *Type:* ServiceNowBasicSettings --- ##### `instanceUrl`^Required ```typescript public readonly instanceUrl: string; ``` - *Type:* string --- ### ServiceNowSourceProps #### Initializer ```typescript import { ServiceNowSourceProps } from '@cdklabs/cdk-appflow' const serviceNowSourceProps: ServiceNowSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | object | string | *No description.* | | profile | ServiceNowConnectorProfile | *No description.* | --- ##### `object`^Required ```typescript public readonly object: string; ``` - *Type:* string --- ##### `profile`^Required ```typescript public readonly profile: ServiceNowConnectorProfile; ``` - *Type:* ServiceNowConnectorProfile --- ### SlackConnectorProfileProps #### Initializer ```typescript import { SlackConnectorProfileProps } from '@cdklabs/cdk-appflow' const slackConnectorProfileProps: SlackConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | instanceUrl | string | *No description.* | | oAuth | SlackOAuthSettings | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `instanceUrl`^Required ```typescript public readonly instanceUrl: string; ``` - *Type:* string --- ##### `oAuth`^Required ```typescript public readonly oAuth: SlackOAuthSettings; ``` - *Type:* SlackOAuthSettings --- ### SlackOAuthSettings #### Initializer ```typescript import { SlackOAuthSettings } from '@cdklabs/cdk-appflow' const slackOAuthSettings: SlackOAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessToken | aws-cdk-lib.SecretValue | *No description.* | | clientId | aws-cdk-lib.SecretValue | *No description.* | | clientSecret | aws-cdk-lib.SecretValue | *No description.* | --- ##### `accessToken`^Required ```typescript public readonly accessToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `clientId`^Optional ```typescript public readonly clientId: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `clientSecret`^Optional ```typescript public readonly clientSecret: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ### SlackSourceProps #### Initializer ```typescript import { SlackSourceProps } from '@cdklabs/cdk-appflow' const slackSourceProps: SlackSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | object | string | *No description.* | | profile | SlackConnectorProfile | *No description.* | | apiVersion | string | *No description.* | --- ##### `object`^Required ```typescript public readonly object: string; ``` - *Type:* string --- ##### `profile`^Required ```typescript public readonly profile: SlackConnectorProfile; ``` - *Type:* SlackConnectorProfile --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string --- ### SnowflakeBasicAuthSettings Snowflake authorization settings required for the profile. #### Initializer ```typescript import { SnowflakeBasicAuthSettings } from '@cdklabs/cdk-appflow' const snowflakeBasicAuthSettings: SnowflakeBasicAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | password | aws-cdk-lib.SecretValue | *No description.* | | username | string | *No description.* | --- ##### `password`^Required ```typescript public readonly password: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `username`^Required ```typescript public readonly username: string; ``` - *Type:* string --- ### SnowflakeConnectorProfileProps Properties for a Snowflake connectorprofile. #### Initializer ```typescript import { SnowflakeConnectorProfileProps } from '@cdklabs/cdk-appflow' const snowflakeConnectorProfileProps: SnowflakeConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | account | string | *No description.* | | basicAuth | SnowflakeBasicAuthSettings | *No description.* | | database | string | The name of the Snowflake database. | | location | S3Location | *No description.* | | stage | string | The name of the Snowflake stage. | | warehouse | string | The name of the Snowflake warehouse. | | integration | SnowflakeStorageIntegration | Details of the Snowflake Storage Integration. | | region | string | *No description.* | | schema | string | The name of the Snowflake schema. | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `account`^Required ```typescript public readonly account: string; ``` - *Type:* string --- ##### `basicAuth`^Required ```typescript public readonly basicAuth: SnowflakeBasicAuthSettings; ``` - *Type:* SnowflakeBasicAuthSettings --- ##### `database`^Required ```typescript public readonly database: string; ``` - *Type:* string The name of the Snowflake database. --- ##### `location`^Required ```typescript public readonly location: S3Location; ``` - *Type:* S3Location --- ##### `stage`^Required ```typescript public readonly stage: string; ``` - *Type:* string The name of the Snowflake stage. --- ##### `warehouse`^Required ```typescript public readonly warehouse: string; ``` - *Type:* string The name of the Snowflake warehouse. --- ##### `integration`^Optional ```typescript public readonly integration: SnowflakeStorageIntegration; ``` - *Type:* SnowflakeStorageIntegration Details of the Snowflake Storage Integration. When provided, this construct will automatically create an IAM Role allowing access to the S3 Bucket which will be available as a [integrationROle property]{@link SnowflakeConnectorProfile#integrationRole } For details of the integration see {@link https://docs.snowflake.com/en/user-guide/data-load-s3-config-storage-integration} --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string --- ##### `schema`^Optional ```typescript public readonly schema: string; ``` - *Type:* string - *Default:* PUBLIC The name of the Snowflake schema. --- ### SnowflakeDestinationObject The destination table in Snowflake. The table needs to reside in the databas and schema provided in the profile. #### Initializer ```typescript import { SnowflakeDestinationObject } from '@cdklabs/cdk-appflow' const snowflakeDestinationObject: SnowflakeDestinationObject = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | table | string | The name of the table object. | --- ##### `table`^Required ```typescript public readonly table: string; ``` - *Type:* string The name of the table object. --- ### SnowflakeDestinationProps Properties that are required to create a Snowflake destination. #### Initializer ```typescript import { SnowflakeDestinationProps } from '@cdklabs/cdk-appflow' const snowflakeDestinationProps: SnowflakeDestinationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | object | SnowflakeDestinationObject | A Snowflake table object (optionally with the schema). | | profile | SnowflakeConnectorProfile | A Snowflake connector profile instance. | | errorHandling | ErrorHandlingConfiguration | The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. | --- ##### `object`^Required ```typescript public readonly object: SnowflakeDestinationObject; ``` - *Type:* SnowflakeDestinationObject A Snowflake table object (optionally with the schema). --- ##### `profile`^Required ```typescript public readonly profile: SnowflakeConnectorProfile; ``` - *Type:* SnowflakeConnectorProfile A Snowflake connector profile instance. --- ##### `errorHandling`^Optional ```typescript public readonly errorHandling: ErrorHandlingConfiguration; ``` - *Type:* ErrorHandlingConfiguration The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. --- ### SnowflakeStorageIntegration #### Initializer ```typescript import { SnowflakeStorageIntegration } from '@cdklabs/cdk-appflow' const snowflakeStorageIntegration: SnowflakeStorageIntegration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | externalId | string | *No description.* | | storageUserArn | string | *No description.* | --- ##### `externalId`^Required ```typescript public readonly externalId: string; ``` - *Type:* string --- ##### `storageUserArn`^Required ```typescript public readonly storageUserArn: string; ``` - *Type:* string --- ### TaskConnectorOperator A pair that represents the (typically source) connector, and a task operation to be performed in the context of the connector. #### Initializer ```typescript import { TaskConnectorOperator } from '@cdklabs/cdk-appflow' const taskConnectorOperator: TaskConnectorOperator = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | operation | string | *No description.* | | type | ConnectorType | *No description.* | --- ##### `operation`^Required ```typescript public readonly operation: string; ``` - *Type:* string --- ##### `type`^Optional ```typescript public readonly type: ConnectorType; ``` - *Type:* ConnectorType --- ### TaskProperty #### Initializer ```typescript import { TaskProperty } from '@cdklabs/cdk-appflow' const taskProperty: TaskProperty = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | *No description.* | | value | string | *No description.* | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string --- ##### `value`^Required ```typescript public readonly value: string; ``` - *Type:* string --- ### TriggerConfig #### Initializer ```typescript import { TriggerConfig } from '@cdklabs/cdk-appflow' const triggerConfig: TriggerConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | properties | TriggerProperties | *No description.* | --- ##### `properties`^Optional ```typescript public readonly properties: TriggerProperties; ``` - *Type:* TriggerProperties --- ### TriggeredFlowBaseProps #### Initializer ```typescript import { TriggeredFlowBaseProps } from '@cdklabs/cdk-appflow' const triggeredFlowBaseProps: TriggeredFlowBaseProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | destination | IDestination | *No description.* | | mappings | IMapping[] | *No description.* | | source | ISource | *No description.* | | description | string | *No description.* | | filters | IFilter[] | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | name | string | *No description.* | | transforms | ITransform[] | *No description.* | | validations | IValidation[] | *No description.* | | autoActivate | boolean | *No description.* | | status | FlowStatus | The status to set on the flow. | --- ##### `destination`^Required ```typescript public readonly destination: IDestination; ``` - *Type:* IDestination --- ##### `mappings`^Required ```typescript public readonly mappings: IMapping[]; ``` - *Type:* IMapping[] --- ##### `source`^Required ```typescript public readonly source: ISource; ``` - *Type:* ISource --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `filters`^Optional ```typescript public readonly filters: IFilter[]; ``` - *Type:* IFilter[] --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `transforms`^Optional ```typescript public readonly transforms: ITransform[]; ``` - *Type:* ITransform[] --- ##### `validations`^Optional ```typescript public readonly validations: IValidation[]; ``` - *Type:* IValidation[] --- ##### ~~`autoActivate`~~^Optional - *Deprecated:* . This property is deprecated and will be removed in a future release. Use {@link status } instead ```typescript public readonly autoActivate: boolean; ``` - *Type:* boolean --- ##### `status`^Optional ```typescript public readonly status: FlowStatus; ``` - *Type:* FlowStatus The status to set on the flow. Use this over {@link autoActivate}. --- ### TriggerProperties #### Initializer ```typescript import { TriggerProperties } from '@cdklabs/cdk-appflow' const triggerProperties: TriggerProperties = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dataPullConfig | DataPullConfig | *No description.* | | schedule | aws-cdk-lib.aws_events.Schedule | *No description.* | | flowErrorDeactivationThreshold | number | *No description.* | | properties | ScheduleProperties | *No description.* | --- ##### `dataPullConfig`^Required ```typescript public readonly dataPullConfig: DataPullConfig; ``` - *Type:* DataPullConfig --- ##### `schedule`^Required ```typescript public readonly schedule: Schedule; ``` - *Type:* aws-cdk-lib.aws_events.Schedule --- ##### `flowErrorDeactivationThreshold`^Optional ```typescript public readonly flowErrorDeactivationThreshold: number; ``` - *Type:* number --- ##### `properties`^Optional ```typescript public readonly properties: ScheduleProperties; ``` - *Type:* ScheduleProperties --- ### ZendeskConnectorProfileProps #### Initializer ```typescript import { ZendeskConnectorProfileProps } from '@cdklabs/cdk-appflow' const zendeskConnectorProfileProps: ZendeskConnectorProfileProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | aws-cdk-lib.aws_kms.IKey | TODO: think if this should be here as not all connector profiles have that. | | name | string | *No description.* | | instanceUrl | string | *No description.* | | oAuth | ZendeskOAuthSettings | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey TODO: think if this should be here as not all connector profiles have that. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `instanceUrl`^Required ```typescript public readonly instanceUrl: string; ``` - *Type:* string --- ##### `oAuth`^Required ```typescript public readonly oAuth: ZendeskOAuthSettings; ``` - *Type:* ZendeskOAuthSettings --- ### ZendeskOAuthSettings #### Initializer ```typescript import { ZendeskOAuthSettings } from '@cdklabs/cdk-appflow' const zendeskOAuthSettings: ZendeskOAuthSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | aws-cdk-lib.SecretValue | *No description.* | | clientSecret | aws-cdk-lib.SecretValue | *No description.* | | accessToken | aws-cdk-lib.SecretValue | *No description.* | --- ##### `clientId`^Required ```typescript public readonly clientId: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `clientSecret`^Required ```typescript public readonly clientSecret: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `accessToken`^Optional ```typescript public readonly accessToken: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ### ZendeskSourceProps #### Initializer ```typescript import { ZendeskSourceProps } from '@cdklabs/cdk-appflow' const zendeskSourceProps: ZendeskSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | object | string | *No description.* | | profile | ZendeskConnectorProfile | *No description.* | | apiVersion | string | *No description.* | --- ##### `object`^Required ```typescript public readonly object: string; ``` - *Type:* string --- ##### `profile`^Required ```typescript public readonly profile: ZendeskConnectorProfile; ``` - *Type:* ZendeskConnectorProfile --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string --- ## Classes ### AmazonRdsForPostgreSqlDestination - *Implements:* IDestination Represents a destination for the Amazon RDS for PostgreSQL connector. #### Initializers ```typescript import { AmazonRdsForPostgreSqlDestination } from '@cdklabs/cdk-appflow' new AmazonRdsForPostgreSqlDestination(props: AmazonRdsForPostgreSqlDestinationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | AmazonRdsForPostgreSqlDestinationProps | - properties of the destination. | --- ##### `props`^Required - *Type:* AmazonRdsForPostgreSqlDestinationProps properties of the destination. --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): DestinationFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### AsanaSource - *Implements:* ISource A class that represents a Asana v3 Source. #### Initializers ```typescript import { AsanaSource } from '@cdklabs/cdk-appflow' new AsanaSource(props: AsanaSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | AsanaSourceProps | *No description.* | --- ##### `props`^Required - *Type:* AsanaSourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): SourceFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### ConnectorType #### Initializers ```typescript import { ConnectorType } from '@cdklabs/cdk-appflow' new ConnectorType(name: string, isCustom: boolean) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | *No description.* | | isCustom | boolean | *No description.* | --- ##### `name`^Required - *Type:* string --- ##### `isCustom`^Required - *Type:* boolean --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | asProfileConnectorType | string | *No description.* | | asTaskConnectorOperatorOrigin | string | *No description.* | | isCustom | boolean | *No description.* | | asProfileConnectorLabel | string | *No description.* | --- ##### `asProfileConnectorType`^Required ```typescript public readonly asProfileConnectorType: string; ``` - *Type:* string --- ##### `asTaskConnectorOperatorOrigin`^Required ```typescript public readonly asTaskConnectorOperatorOrigin: string; ``` - *Type:* string --- ##### `isCustom`^Required ```typescript public readonly isCustom: boolean; ``` - *Type:* boolean --- ##### `asProfileConnectorLabel`^Optional ```typescript public readonly asProfileConnectorLabel: string; ``` - *Type:* string --- ### EventBridgeDestination - *Implements:* IDestination This class represents AppFlow's EventBridge destination. #### Initializers ```typescript import { EventBridgeDestination } from '@cdklabs/cdk-appflow' new EventBridgeDestination(props: EventBridgeDestinationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | EventBridgeDestinationProps | *No description.* | --- ##### `props`^Required - *Type:* EventBridgeDestinationProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): DestinationFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### EventSources #### Initializers ```typescript import { EventSources } from '@cdklabs/cdk-appflow' new EventSources() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | salesforceEventSource | *No description.* | --- ##### `salesforceEventSource` ```typescript import { EventSources } from '@cdklabs/cdk-appflow' EventSources.salesforceEventSource(suffix?: string) ``` ###### `suffix`^Optional - *Type:* string --- ### Filter - *Implements:* IFilter A representation of a mapping operation, that is an operation filtering records at the source. #### Initializers ```typescript import { Filter } from '@cdklabs/cdk-appflow' new Filter(condition: FilterCondition) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | condition | FilterCondition | *No description.* | --- ##### `condition`^Required - *Type:* FilterCondition --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow, source: ISource): TaskProperty[] ``` ###### `flow`^Required - *Type:* IFlow --- ###### `source`^Required - *Type:* ISource --- #### Static Functions | **Name** | **Description** | | --- | --- | | when | Builds a filter operation on source. | --- ##### `when` ```typescript import { Filter } from '@cdklabs/cdk-appflow' Filter.when(condition: FilterCondition) ``` Builds a filter operation on source. > [FilterCondition instance](FilterCondition instance) ###### `condition`^Required - *Type:* FilterCondition a. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | condition | FilterCondition | *No description.* | --- ##### `condition`^Required ```typescript public readonly condition: FilterCondition; ``` - *Type:* FilterCondition --- ### FilterCondition A representation of a filter operation condtiion on a source record field. #### Initializers ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' new FilterCondition(field: Field, filter: string, properties: TaskProperty[]) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | field | Field | *No description.* | | filter | string | *No description.* | | properties | TaskProperty[] | *No description.* | --- ##### `field`^Required - *Type:* Field --- ##### `filter`^Required - *Type:* string --- ##### `properties`^Required - *Type:* TaskProperty[] --- #### Static Functions | **Name** | **Description** | | --- | --- | | booleanEquals | *No description.* | | booleanNotEquals | *No description.* | | numberEquals | *No description.* | | numberGreaterThan | *No description.* | | numberGreaterThanEquals | *No description.* | | numberLessThan | *No description.* | | numberLessThanEquals | *No description.* | | numberNotEquals | *No description.* | | stringContains | A condition testing whether a string-type source field contains the given value(s). | | stringEquals | A condition testing whether a string-type source field equals the given value(s). | | stringNotEquals | A condition testing whether a string-type source field does not equal the given value(s). | | timestampBetween | *No description.* | | timestampEquals | *No description.* | | timestampGreaterThan | *No description.* | | timestampGreaterThanEquals | *No description.* | | timestampLessThan | *No description.* | | timestampLessThanEquals | *No description.* | | timestampNotEquals | *No description.* | --- ##### `booleanEquals` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.booleanEquals(field: Field, val: boolean | boolean[]) ``` ###### `field`^Required - *Type:* Field --- ###### `val`^Required - *Type:* boolean | boolean[] --- ##### `booleanNotEquals` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.booleanNotEquals(field: Field, val: boolean | boolean[]) ``` ###### `field`^Required - *Type:* Field --- ###### `val`^Required - *Type:* boolean | boolean[] --- ##### `numberEquals` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.numberEquals(field: Field, val: number | number[]) ``` ###### `field`^Required - *Type:* Field --- ###### `val`^Required - *Type:* number | number[] --- ##### `numberGreaterThan` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.numberGreaterThan(field: Field, val: number) ``` ###### `field`^Required - *Type:* Field --- ###### `val`^Required - *Type:* number --- ##### `numberGreaterThanEquals` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.numberGreaterThanEquals(field: Field, val: number) ``` ###### `field`^Required - *Type:* Field --- ###### `val`^Required - *Type:* number --- ##### `numberLessThan` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.numberLessThan(field: Field, val: number) ``` ###### `field`^Required - *Type:* Field --- ###### `val`^Required - *Type:* number --- ##### `numberLessThanEquals` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.numberLessThanEquals(field: Field, val: number) ``` ###### `field`^Required - *Type:* Field --- ###### `val`^Required - *Type:* number --- ##### `numberNotEquals` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.numberNotEquals(field: Field, val: number | number[]) ``` ###### `field`^Required - *Type:* Field --- ###### `val`^Required - *Type:* number | number[] --- ##### `stringContains` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.stringContains(field: Field, val: string | string[]) ``` A condition testing whether a string-type source field contains the given value(s). NOTE: When multiple values are passed the evaluation is resolved as logical OR > [FilterCondition](FilterCondition) ###### `field`^Required - *Type:* Field a source field of a string type. --- ###### `val`^Required - *Type:* string | string[] a value (or values) to be contained by the field value. --- ##### `stringEquals` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.stringEquals(field: Field, val: string | string[]) ``` A condition testing whether a string-type source field equals the given value(s). NOTE: When multiple values are passed the evaluation is resolved as logical OR > [FilterCondition](FilterCondition) ###### `field`^Required - *Type:* Field a source field of a string type. --- ###### `val`^Required - *Type:* string | string[] a value (or values) to be contained by the field value. --- ##### `stringNotEquals` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.stringNotEquals(field: Field, val: string | string[]) ``` A condition testing whether a string-type source field does not equal the given value(s). NOTE: When multiple values are passed the evaluation is resolved as logical OR > [FilterCondition](FilterCondition) ###### `field`^Required - *Type:* Field a source field of a string type. --- ###### `val`^Required - *Type:* string | string[] a value (or values) to be contained by the field value. --- ##### `timestampBetween` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.timestampBetween(field: Field, lower: Date, upper: Date) ``` ###### `field`^Required - *Type:* Field --- ###### `lower`^Required - *Type:* Date --- ###### `upper`^Required - *Type:* Date --- ##### `timestampEquals` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.timestampEquals(field: Field, val: Date | Date[]) ``` ###### `field`^Required - *Type:* Field --- ###### `val`^Required - *Type:* Date | Date[] --- ##### `timestampGreaterThan` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.timestampGreaterThan(field: Field, val: Date | Date[]) ``` ###### `field`^Required - *Type:* Field --- ###### `val`^Required - *Type:* Date | Date[] --- ##### `timestampGreaterThanEquals` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.timestampGreaterThanEquals(field: Field, val: Date | Date[]) ``` ###### `field`^Required - *Type:* Field --- ###### `val`^Required - *Type:* Date | Date[] --- ##### `timestampLessThan` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.timestampLessThan(field: Field, val: Date | Date[]) ``` ###### `field`^Required - *Type:* Field --- ###### `val`^Required - *Type:* Date | Date[] --- ##### `timestampLessThanEquals` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.timestampLessThanEquals(field: Field, val: Date | Date[]) ``` ###### `field`^Required - *Type:* Field --- ###### `val`^Required - *Type:* Date | Date[] --- ##### `timestampNotEquals` ```typescript import { FilterCondition } from '@cdklabs/cdk-appflow' FilterCondition.timestampNotEquals(field: Field, val: Date | Date[]) ``` ###### `field`^Required - *Type:* Field --- ###### `val`^Required - *Type:* Date | Date[] --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | field | Field | *No description.* | | filter | string | *No description.* | | properties | TaskProperty[] | *No description.* | --- ##### `field`^Required ```typescript public readonly field: Field; ``` - *Type:* Field --- ##### `filter`^Required ```typescript public readonly filter: string; ``` - *Type:* string --- ##### `properties`^Required ```typescript public readonly properties: TaskProperty[]; ``` - *Type:* TaskProperty[] --- ### GoogleAdsSource - *Implements:* ISource A class that represents a Google Ads v4 Source. #### Initializers ```typescript import { GoogleAdsSource } from '@cdklabs/cdk-appflow' new GoogleAdsSource(props: GoogleAdsSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | GoogleAdsSourceProps | *No description.* | --- ##### `props`^Required - *Type:* GoogleAdsSourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(scope: IFlow): SourceFlowConfigProperty ``` ###### `scope`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### GoogleAnalytics4Source - *Implements:* ISource A class that represents a Google Analytics v4 Source. #### Initializers ```typescript import { GoogleAnalytics4Source } from '@cdklabs/cdk-appflow' new GoogleAnalytics4Source(props: GoogleAnalytics4SourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | GoogleAnalytics4SourceProps | *No description.* | --- ##### `props`^Required - *Type:* GoogleAnalytics4SourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(scope: IFlow): SourceFlowConfigProperty ``` ###### `scope`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### GoogleBigQuerySource - *Implements:* ISource A class that represents a Google BigQuery Source. #### Initializers ```typescript import { GoogleBigQuerySource } from '@cdklabs/cdk-appflow' new GoogleBigQuerySource(props: GoogleBigQuerySourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | GoogleBigQuerySourceProps | *No description.* | --- ##### `props`^Required - *Type:* GoogleBigQuerySourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(scope: IFlow): SourceFlowConfigProperty ``` ###### `scope`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### HubSpotDestination - *Implements:* IDestination #### Initializers ```typescript import { HubSpotDestination } from '@cdklabs/cdk-appflow' new HubSpotDestination(props: HubSpotDestinationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | HubSpotDestinationProps | *No description.* | --- ##### `props`^Required - *Type:* HubSpotDestinationProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): DestinationFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### HubSpotSource - *Implements:* ISource A class that represents a Hubspot Source. #### Initializers ```typescript import { HubSpotSource } from '@cdklabs/cdk-appflow' new HubSpotSource(props: HubSpotSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | HubSpotSourceProps | *No description.* | --- ##### `props`^Required - *Type:* HubSpotSourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(scope: IFlow): SourceFlowConfigProperty ``` ###### `scope`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### JdbcSmallDataScaleSource - *Implements:* ISource #### Initializers ```typescript import { JdbcSmallDataScaleSource } from '@cdklabs/cdk-appflow' new JdbcSmallDataScaleSource(props: JdbcSmallDataScaleSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | JdbcSmallDataScaleSourceProps | *No description.* | --- ##### `props`^Required - *Type:* JdbcSmallDataScaleSourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): SourceFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### MailchimpSource - *Implements:* ISource A class that represents a Mailchimp v3 Source. #### Initializers ```typescript import { MailchimpSource } from '@cdklabs/cdk-appflow' new MailchimpSource(props: MailchimpSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | MailchimpSourceProps | *No description.* | --- ##### `props`^Required - *Type:* MailchimpSourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): SourceFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### Mapping - *Implements:* IMapping A representation of an instance of a mapping operation, that is an operation translating source to destination fields. #### Initializers ```typescript import { Mapping } from '@cdklabs/cdk-appflow' new Mapping(tasks: ITask[]) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | tasks | ITask[] | *No description.* | --- ##### `tasks`^Required - *Type:* ITask[] --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow, source: ISource): TaskProperty[] ``` ###### `flow`^Required - *Type:* IFlow --- ###### `source`^Required - *Type:* ISource --- #### Static Functions | **Name** | **Description** | | --- | --- | | add | Specifies an addition mapping of two numeric values from asource to a destination. | | concat | A mapping definition building concatenation of source fields into a destination field. | | divide | Specifies a division mapping of two numeric values from a source to a destination. | | map | *No description.* | | mapAll | *No description.* | | multiply | Specifies a multiplication mapping of two numeric values from a source to a destination. | | subtract | Specifies a subtraction mapping of two numeric values from a source to a destination. | --- ##### `add` ```typescript import { Mapping } from '@cdklabs/cdk-appflow' Mapping.add(sourceField1: Field, sourceField2: Field, to: Field) ``` Specifies an addition mapping of two numeric values from asource to a destination. ###### `sourceField1`^Required - *Type:* Field a numeric value. --- ###### `sourceField2`^Required - *Type:* Field a numeric value. --- ###### `to`^Required - *Type:* Field a numeric value. --- ##### `concat` ```typescript import { Mapping } from '@cdklabs/cdk-appflow' Mapping.concat(from: Field[], to: Field, format: string) ``` A mapping definition building concatenation of source fields into a destination field. ###### `from`^Required - *Type:* Field[] an array of source fields. --- ###### `to`^Required - *Type:* Field a desintation field. --- ###### `format`^Required - *Type:* string a format. --- ##### `divide` ```typescript import { Mapping } from '@cdklabs/cdk-appflow' Mapping.divide(sourceField1: Field, sourceField2: Field, to: Field) ``` Specifies a division mapping of two numeric values from a source to a destination. ###### `sourceField1`^Required - *Type:* Field a numeric value. --- ###### `sourceField2`^Required - *Type:* Field a numeric value. --- ###### `to`^Required - *Type:* Field a numeric value. --- ##### `map` ```typescript import { Mapping } from '@cdklabs/cdk-appflow' Mapping.map(from: Field, to: Field) ``` ###### `from`^Required - *Type:* Field --- ###### `to`^Required - *Type:* Field --- ##### `mapAll` ```typescript import { Mapping } from '@cdklabs/cdk-appflow' Mapping.mapAll(config?: MapAllConfig) ``` ###### `config`^Optional - *Type:* MapAllConfig --- ##### `multiply` ```typescript import { Mapping } from '@cdklabs/cdk-appflow' Mapping.multiply(sourceField1: Field, sourceField2: Field, to: Field) ``` Specifies a multiplication mapping of two numeric values from a source to a destination. ###### `sourceField1`^Required - *Type:* Field a numeric value. --- ###### `sourceField2`^Required - *Type:* Field a numeric value. --- ###### `to`^Required - *Type:* Field a numeric value. --- ##### `subtract` ```typescript import { Mapping } from '@cdklabs/cdk-appflow' Mapping.subtract(sourceField1: Field, sourceField2: Field, to: Field) ``` Specifies a subtraction mapping of two numeric values from a source to a destination. ###### `sourceField1`^Required - *Type:* Field a numeric value. --- ###### `sourceField2`^Required - *Type:* Field a numeric value. --- ###### `to`^Required - *Type:* Field a numeric value. --- ### MarketoInstanceUrlBuilder #### Initializers ```typescript import { MarketoInstanceUrlBuilder } from '@cdklabs/cdk-appflow' new MarketoInstanceUrlBuilder() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | buildFromAccount | *No description.* | --- ##### `buildFromAccount` ```typescript import { MarketoInstanceUrlBuilder } from '@cdklabs/cdk-appflow' MarketoInstanceUrlBuilder.buildFromAccount(account: string) ``` ###### `account`^Required - *Type:* string --- ### MarketoSource - *Implements:* ISource #### Initializers ```typescript import { MarketoSource } from '@cdklabs/cdk-appflow' new MarketoSource(props: MarketoSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | MarketoSourceProps | *No description.* | --- ##### `props`^Required - *Type:* MarketoSourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): SourceFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### MicrosoftDynamics365ApiUrlBuilder #### Initializers ```typescript import { MicrosoftDynamics365ApiUrlBuilder } from '@cdklabs/cdk-appflow' new MicrosoftDynamics365ApiUrlBuilder() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | buildApiUrl | *No description.* | --- ##### `buildApiUrl` ```typescript import { MicrosoftDynamics365ApiUrlBuilder } from '@cdklabs/cdk-appflow' MicrosoftDynamics365ApiUrlBuilder.buildApiUrl(org: string) ``` ###### `org`^Required - *Type:* string --- ### MicrosoftDynamics365Source - *Implements:* ISource A class that represents a Microsoft Dynamics 365 Source. #### Initializers ```typescript import { MicrosoftDynamics365Source } from '@cdklabs/cdk-appflow' new MicrosoftDynamics365Source(props: MicrosoftDynamics365SourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | MicrosoftDynamics365SourceProps | *No description.* | --- ##### `props`^Required - *Type:* MicrosoftDynamics365SourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(scope: IFlow): SourceFlowConfigProperty ``` ###### `scope`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### MicrosoftDynamics365TokenUrlBuilder A utility class for building Microsoft Dynamics 365 token URLs. #### Initializers ```typescript import { MicrosoftDynamics365TokenUrlBuilder } from '@cdklabs/cdk-appflow' new MicrosoftDynamics365TokenUrlBuilder() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | buildTokenUrl | *No description.* | --- ##### `buildTokenUrl` ```typescript import { MicrosoftDynamics365TokenUrlBuilder } from '@cdklabs/cdk-appflow' MicrosoftDynamics365TokenUrlBuilder.buildTokenUrl(tenantId?: string) ``` ###### `tenantId`^Optional - *Type:* string --- ### MicrosoftSharepointOnlineSource - *Implements:* ISource A class that represents a Microsoft Sharepoint Online Source. #### Initializers ```typescript import { MicrosoftSharepointOnlineSource } from '@cdklabs/cdk-appflow' new MicrosoftSharepointOnlineSource(props: MicrosoftSharepointOnlineSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | MicrosoftSharepointOnlineSourceProps | *No description.* | --- ##### `props`^Required - *Type:* MicrosoftSharepointOnlineSourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(scope: IFlow): SourceFlowConfigProperty ``` ###### `scope`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### MicrosoftSharepointOnlineTokenUrlBuilder A utility class for building Microsoft Online token URLs. #### Initializers ```typescript import { MicrosoftSharepointOnlineTokenUrlBuilder } from '@cdklabs/cdk-appflow' new MicrosoftSharepointOnlineTokenUrlBuilder() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | buildTokenUrl | *No description.* | --- ##### `buildTokenUrl` ```typescript import { MicrosoftSharepointOnlineTokenUrlBuilder } from '@cdklabs/cdk-appflow' MicrosoftSharepointOnlineTokenUrlBuilder.buildTokenUrl(tenantId?: string) ``` ###### `tenantId`^Optional - *Type:* string --- ### OperationBase - *Implements:* IOperation A base class for all operations. #### Initializers ```typescript import { OperationBase } from '@cdklabs/cdk-appflow' new OperationBase(tasks: ITask[]) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | tasks | ITask[] | *No description.* | --- ##### `tasks`^Required - *Type:* ITask[] --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow, source: ISource): TaskProperty[] ``` ###### `flow`^Required - *Type:* IFlow --- ###### `source`^Required - *Type:* ISource --- ### RedshiftDestination - *Implements:* IDestination #### Initializers ```typescript import { RedshiftDestination } from '@cdklabs/cdk-appflow' new RedshiftDestination(props: RedshiftDestinationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | RedshiftDestinationProps | *No description.* | --- ##### `props`^Required - *Type:* RedshiftDestinationProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(scope: IFlow): DestinationFlowConfigProperty ``` ###### `scope`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### S3Destination - *Implements:* IDestination #### Initializers ```typescript import { S3Destination } from '@cdklabs/cdk-appflow' new S3Destination(props: S3DestinationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | S3DestinationProps | *No description.* | --- ##### `props`^Required - *Type:* S3DestinationProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): DestinationFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### S3Source - *Implements:* ISource #### Initializers ```typescript import { S3Source } from '@cdklabs/cdk-appflow' new S3Source(props: S3SourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | S3SourceProps | *No description.* | --- ##### `props`^Required - *Type:* S3SourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(scope: IFlow): SourceFlowConfigProperty ``` ###### `scope`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### SalesforceDestination - *Implements:* IDestination #### Initializers ```typescript import { SalesforceDestination } from '@cdklabs/cdk-appflow' new SalesforceDestination(props: SalesforceDestinationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | SalesforceDestinationProps | *No description.* | --- ##### `props`^Required - *Type:* SalesforceDestinationProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): DestinationFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### SalesforceMarketingCloudSource - *Implements:* ISource A class that represents a Salesforce Marketing Cloud Source. #### Initializers ```typescript import { SalesforceMarketingCloudSource } from '@cdklabs/cdk-appflow' new SalesforceMarketingCloudSource(props: SalesforceMarketingCloudSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | SalesforceMarketingCloudSourceProps | *No description.* | --- ##### `props`^Required - *Type:* SalesforceMarketingCloudSourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(scope: IFlow): SourceFlowConfigProperty ``` ###### `scope`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### SalesforceSource - *Implements:* ISource #### Initializers ```typescript import { SalesforceSource } from '@cdklabs/cdk-appflow' new SalesforceSource(props: SalesforceSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | SalesforceSourceProps | *No description.* | --- ##### `props`^Required - *Type:* SalesforceSourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): SourceFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### SAPOdataDestination - *Implements:* IDestination #### Initializers ```typescript import { SAPOdataDestination } from '@cdklabs/cdk-appflow' new SAPOdataDestination(props: SAPOdataDestinationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | SAPOdataDestinationProps | *No description.* | --- ##### `props`^Required - *Type:* SAPOdataDestinationProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): DestinationFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### SAPOdataSource - *Implements:* ISource #### Initializers ```typescript import { SAPOdataSource } from '@cdklabs/cdk-appflow' new SAPOdataSource(props: SAPOdataSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | SAPOdataSourceProps | *No description.* | --- ##### `props`^Required - *Type:* SAPOdataSourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): SourceFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### ServiceNowInstanceUrlBuilder #### Initializers ```typescript import { ServiceNowInstanceUrlBuilder } from '@cdklabs/cdk-appflow' new ServiceNowInstanceUrlBuilder() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | buildFromDomain | *No description.* | --- ##### `buildFromDomain` ```typescript import { ServiceNowInstanceUrlBuilder } from '@cdklabs/cdk-appflow' ServiceNowInstanceUrlBuilder.buildFromDomain(domain: string) ``` ###### `domain`^Required - *Type:* string --- ### ServiceNowSource - *Implements:* ISource #### Initializers ```typescript import { ServiceNowSource } from '@cdklabs/cdk-appflow' new ServiceNowSource(props: ServiceNowSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ServiceNowSourceProps | *No description.* | --- ##### `props`^Required - *Type:* ServiceNowSourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): SourceFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### SlackInstanceUrlBuilder #### Initializers ```typescript import { SlackInstanceUrlBuilder } from '@cdklabs/cdk-appflow' new SlackInstanceUrlBuilder() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | buildFromWorkspace | *No description.* | --- ##### `buildFromWorkspace` ```typescript import { SlackInstanceUrlBuilder } from '@cdklabs/cdk-appflow' SlackInstanceUrlBuilder.buildFromWorkspace(workspace: string) ``` ###### `workspace`^Required - *Type:* string --- ### SlackSource - *Implements:* ISource #### Initializers ```typescript import { SlackSource } from '@cdklabs/cdk-appflow' new SlackSource(props: SlackSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | SlackSourceProps | *No description.* | --- ##### `props`^Required - *Type:* SlackSourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): SourceFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### SnowflakeDestination - *Implements:* IDestination A Snowflake destination. #### Initializers ```typescript import { SnowflakeDestination } from '@cdklabs/cdk-appflow' new SnowflakeDestination(props: SnowflakeDestinationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | SnowflakeDestinationProps | *No description.* | --- ##### `props`^Required - *Type:* SnowflakeDestinationProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(scope: IFlow): DestinationFlowConfigProperty ``` ###### `scope`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### Task - *Implements:* ITask A representation of a unitary action on the record fields. #### Initializers ```typescript import { Task } from '@cdklabs/cdk-appflow' new Task(type: string, sourceFields: string[], connectorOperator: TaskConnectorOperator, properties: TaskProperty[], destinationField?: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | type | string | *No description.* | | sourceFields | string[] | *No description.* | | connectorOperator | TaskConnectorOperator | *No description.* | | properties | TaskProperty[] | *No description.* | | destinationField | string | *No description.* | --- ##### `type`^Required - *Type:* string --- ##### `sourceFields`^Required - *Type:* string[] --- ##### `connectorOperator`^Required - *Type:* TaskConnectorOperator --- ##### `properties`^Required - *Type:* TaskProperty[] --- ##### `destinationField`^Optional - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(_flow: IFlow, source: ISource): TaskProperty ``` ###### `_flow`^Required - *Type:* IFlow --- ###### `source`^Required - *Type:* ISource --- ### Transform - *Implements:* ITransform A representation of a transform operation, that is an operation modifying source fields. #### Initializers ```typescript import { Transform } from '@cdklabs/cdk-appflow' new Transform(tasks: ITask[]) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | tasks | ITask[] | *No description.* | --- ##### `tasks`^Required - *Type:* ITask[] --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow, source: ISource): TaskProperty[] ``` ###### `flow`^Required - *Type:* IFlow --- ###### `source`^Required - *Type:* ISource --- #### Static Functions | **Name** | **Description** | | --- | --- | | mask | Masks the field with a specified mask. | | maskEnd | *No description.* | | maskStart | *No description.* | | truncate | Truncates the field to a specified length. | --- ##### `mask` ```typescript import { Transform } from '@cdklabs/cdk-appflow' Transform.mask(field: string | Field, mask?: string) ``` Masks the field with a specified mask. > [Transform instance](Transform instance) ###### `field`^Required - *Type:* string | Field a source field to mask. --- ###### `mask`^Optional - *Type:* string a mask character. --- ##### `maskEnd` ```typescript import { Transform } from '@cdklabs/cdk-appflow' Transform.maskEnd(field: string | Field, length: number, mask?: string) ``` ###### `field`^Required - *Type:* string | Field --- ###### `length`^Required - *Type:* number --- ###### `mask`^Optional - *Type:* string --- ##### `maskStart` ```typescript import { Transform } from '@cdklabs/cdk-appflow' Transform.maskStart(field: string | Field, length: number, mask?: string) ``` ###### `field`^Required - *Type:* string | Field --- ###### `length`^Required - *Type:* number --- ###### `mask`^Optional - *Type:* string --- ##### `truncate` ```typescript import { Transform } from '@cdklabs/cdk-appflow' Transform.truncate(field: string | Field, length: number) ``` Truncates the field to a specified length. > [Transform instance](Transform instance) ###### `field`^Required - *Type:* string | Field a source field to truncate. --- ###### `length`^Required - *Type:* number the maximum length after truncation. --- ### Validation - *Implements:* IValidation A representation of a validation operation, that is an operation testing records and acting on the test results. #### Initializers ```typescript import { Validation } from '@cdklabs/cdk-appflow' new Validation(condition: ValidationCondition, action: ValidationAction) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | condition | ValidationCondition | *No description.* | | action | ValidationAction | *No description.* | --- ##### `condition`^Required - *Type:* ValidationCondition --- ##### `action`^Required - *Type:* ValidationAction --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow, source: ISource): TaskProperty[] ``` ###### `flow`^Required - *Type:* IFlow --- ###### `source`^Required - *Type:* ISource --- #### Static Functions | **Name** | **Description** | | --- | --- | | when | *No description.* | --- ##### `when` ```typescript import { Validation } from '@cdklabs/cdk-appflow' Validation.when(condition: ValidationCondition, action: ValidationAction) ``` > [ValidationAction for the validation](ValidationAction for the validation) ###### `condition`^Required - *Type:* ValidationCondition a. --- ###### `action`^Required - *Type:* ValidationAction a. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | ValidationAction | *No description.* | | condition | ValidationCondition | *No description.* | --- ##### `action`^Required ```typescript public readonly action: ValidationAction; ``` - *Type:* ValidationAction --- ##### `condition`^Required ```typescript public readonly condition: ValidationCondition; ``` - *Type:* ValidationCondition --- ### ValidationAction #### Initializers ```typescript import { ValidationAction } from '@cdklabs/cdk-appflow' new ValidationAction(action: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`^Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | ignoreRecord | *No description.* | | terminateFlow | *No description.* | --- ##### `ignoreRecord` ```typescript import { ValidationAction } from '@cdklabs/cdk-appflow' ValidationAction.ignoreRecord() ``` > [ValidationAction that removes a record from the flow execution result](ValidationAction that removes a record from the flow execution result) ##### `terminateFlow` ```typescript import { ValidationAction } from '@cdklabs/cdk-appflow' ValidationAction.terminateFlow() ``` > [ValidationAction that terminates the whole flow execution](ValidationAction that terminates the whole flow execution) #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`^Required ```typescript public readonly action: string; ``` - *Type:* string --- ### ValidationCondition A representation of a validation condition on a particular field in a flow execution. #### Initializers ```typescript import { ValidationCondition } from '@cdklabs/cdk-appflow' new ValidationCondition(field: string, validation: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | field | string | *No description.* | | validation | string | *No description.* | --- ##### `field`^Required - *Type:* string --- ##### `validation`^Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | isDefault | *No description.* | | isNegative | Validates whether a particular field in an execution is negative. | | isNotNull | *No description.* | | isNull | Validates whether a particular field has no value. | --- ##### `isDefault` ```typescript import { ValidationCondition } from '@cdklabs/cdk-appflow' ValidationCondition.isDefault(field: string | Field) ``` > [ValidationCondition instance](ValidationCondition instance) ###### `field`^Required - *Type:* string | Field a field for which the validation will be performed. --- ##### `isNegative` ```typescript import { ValidationCondition } from '@cdklabs/cdk-appflow' ValidationCondition.isNegative(field: string | Field) ``` Validates whether a particular field in an execution is negative. > [ValidationCondition instance](ValidationCondition instance) ###### `field`^Required - *Type:* string | Field a field for which the validation will be performed. --- ##### `isNotNull` ```typescript import { ValidationCondition } from '@cdklabs/cdk-appflow' ValidationCondition.isNotNull(field: string | Field) ``` > [ValidationCondition instance](ValidationCondition instance) ###### `field`^Required - *Type:* string | Field a field for which the validation will be performed. --- ##### `isNull` ```typescript import { ValidationCondition } from '@cdklabs/cdk-appflow' ValidationCondition.isNull(field: string | Field) ``` Validates whether a particular field has no value. > [ValidationCondition instance](ValidationCondition instance) ###### `field`^Required - *Type:* string | Field a field for which the validation will be performed. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | field | string | *No description.* | | validation | string | *No description.* | --- ##### `field`^Required ```typescript public readonly field: string; ``` - *Type:* string --- ##### `validation`^Required ```typescript public readonly validation: string; ``` - *Type:* string --- ### WriteOperation #### Initializers ```typescript import { WriteOperation } from '@cdklabs/cdk-appflow' new WriteOperation(type: WriteOperationType, ids?: string[]) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | type | WriteOperationType | *No description.* | | ids | string[] | *No description.* | --- ##### `type`^Required - *Type:* WriteOperationType --- ##### `ids`^Optional - *Type:* string[] --- #### Static Functions | **Name** | **Description** | | --- | --- | | delete | *No description.* | | insert | *No description.* | | update | *No description.* | | upsert | *No description.* | --- ##### `delete` ```typescript import { WriteOperation } from '@cdklabs/cdk-appflow' WriteOperation.delete(ids?: string[]) ``` ###### `ids`^Optional - *Type:* string[] --- ##### `insert` ```typescript import { WriteOperation } from '@cdklabs/cdk-appflow' WriteOperation.insert(ids?: string[]) ``` ###### `ids`^Optional - *Type:* string[] --- ##### `update` ```typescript import { WriteOperation } from '@cdklabs/cdk-appflow' WriteOperation.update(ids?: string[]) ``` ###### `ids`^Optional - *Type:* string[] --- ##### `upsert` ```typescript import { WriteOperation } from '@cdklabs/cdk-appflow' WriteOperation.upsert(ids?: string[]) ``` ###### `ids`^Optional - *Type:* string[] --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | WriteOperationType | *No description.* | | ids | string[] | *No description.* | --- ##### `type`^Required ```typescript public readonly type: WriteOperationType; ``` - *Type:* WriteOperationType --- ##### `ids`^Optional ```typescript public readonly ids: string[]; ``` - *Type:* string[] --- ### ZendeskInstanceUrlBuilder #### Initializers ```typescript import { ZendeskInstanceUrlBuilder } from '@cdklabs/cdk-appflow' new ZendeskInstanceUrlBuilder() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | buildFromAccount | *No description.* | --- ##### `buildFromAccount` ```typescript import { ZendeskInstanceUrlBuilder } from '@cdklabs/cdk-appflow' ZendeskInstanceUrlBuilder.buildFromAccount(account: string) ``` ###### `account`^Required - *Type:* string --- ### ZendeskSource - *Implements:* ISource #### Initializers ```typescript import { ZendeskSource } from '@cdklabs/cdk-appflow' new ZendeskSource(props: ZendeskSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ZendeskSourceProps | *No description.* | --- ##### `props`^Required - *Type:* ZendeskSourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow): SourceFlowConfigProperty ``` ###### `flow`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ## Protocols ### IConnectorProfile - *Extends:* aws-cdk-lib.IResource - *Implemented By:* AmazonRdsForPostgreSqlConnectorProfile, AsanaConnectorProfile, ConnectorProfileBase, GoogleAdsConnectorProfile, GoogleAnalytics4ConnectorProfile, GoogleBigQueryConnectorProfile, HubSpotConnectorProfile, JdbcSmallDataScaleConnectorProfile, MailchimpConnectorProfile, MarketoConnectorProfile, MicrosoftDynamics365ConnectorProfile, MicrosoftSharepointOnlineConnectorProfile, RedshiftConnectorProfile, SAPOdataConnectorProfile, SalesforceConnectorProfile, SalesforceMarketingCloudConnectorProfile, ServiceNowConnectorProfile, SlackConnectorProfile, SnowflakeConnectorProfile, ZendeskConnectorProfile, IConnectorProfile #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | name | string | *No description.* | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `credentials`^Optional ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### IDestination - *Extends:* IVertex - *Implemented By:* AmazonRdsForPostgreSqlDestination, EventBridgeDestination, HubSpotDestination, RedshiftDestination, S3Destination, SAPOdataDestination, SalesforceDestination, SnowflakeDestination, IDestination A destination of an AppFlow flow. #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(scope: IFlow): DestinationFlowConfigProperty ``` ###### `scope`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### IFilter - *Extends:* IOperation - *Implemented By:* Filter, IFilter A representation of a mapping operation, that is an operation filtering records at the source. ### IFlow - *Extends:* aws-cdk-lib.IResource - *Implemented By:* FlowBase, OnDemandFlow, OnEventFlow, OnScheduleFlow, TriggeredFlowBase, IFlow #### Methods | **Name** | **Description** | | --- | --- | | metricFlowExecutionRecordsProcessed | Creates a metric to report the number of records that Amazon AppFlow attempted to transfer for the flow run. | | metricFlowExecutionsFailed | Creates a metric to report the number of failed flow runs. | | metricFlowExecutionsStarted | Creates a metric to report the number of flow runs started. | | metricFlowExecutionsSucceeded | Creates a metric to report the number of successful flow runs. | | metricFlowExecutionTime | Creates a metric to report the interval, in milliseconds, between the time the flow starts and the time it finishes. | | onRunCompleted | *No description.* | | onRunStarted | *No description.* | --- ##### `metricFlowExecutionRecordsProcessed` ```typescript public metricFlowExecutionRecordsProcessed(options?: MetricOptions): Metric ``` Creates a metric to report the number of records that Amazon AppFlow attempted to transfer for the flow run. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsFailed` ```typescript public metricFlowExecutionsFailed(options?: MetricOptions): Metric ``` Creates a metric to report the number of failed flow runs. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsStarted` ```typescript public metricFlowExecutionsStarted(options?: MetricOptions): Metric ``` Creates a metric to report the number of flow runs started. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionsSucceeded` ```typescript public metricFlowExecutionsSucceeded(options?: MetricOptions): Metric ``` Creates a metric to report the number of successful flow runs. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFlowExecutionTime` ```typescript public metricFlowExecutionTime(options?: MetricOptions): Metric ``` Creates a metric to report the interval, in milliseconds, between the time the flow starts and the time it finishes. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `onRunCompleted` ```typescript public onRunCompleted(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `onRunStarted` ```typescript public onRunStarted(id: string, options?: OnEventOptions): Rule ``` ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | The ARN of the flow. | | name | string | The name of the flow. | | type | FlowType | The type of the flow. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string The ARN of the flow. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the flow. --- ##### `type`^Required ```typescript public readonly type: FlowType; ``` - *Type:* FlowType The type of the flow. --- ### IMapping - *Extends:* IOperation - *Implemented By:* Mapping, IMapping A representation of a mapping operation, that is an operation translating source to destination fields. ### IOperation - *Implemented By:* Filter, Mapping, OperationBase, Transform, Validation, IFilter, IMapping, IOperation, ITransform, IValidation A representation of a set of tasks that deliver complete operation. #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow, source: ISource): TaskProperty[] ``` ###### `flow`^Required - *Type:* IFlow --- ###### `source`^Required - *Type:* ISource --- ### ISource - *Extends:* IVertex - *Implemented By:* AsanaSource, GoogleAdsSource, GoogleAnalytics4Source, GoogleBigQuerySource, HubSpotSource, JdbcSmallDataScaleSource, MailchimpSource, MarketoSource, MicrosoftDynamics365Source, MicrosoftSharepointOnlineSource, S3Source, SAPOdataSource, SalesforceMarketingCloudSource, SalesforceSource, ServiceNowSource, SlackSource, ZendeskSource, ISource A source of an AppFlow flow. #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(scope: IFlow): SourceFlowConfigProperty ``` ###### `scope`^Required - *Type:* IFlow --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ### ITask - *Implemented By:* Task, ITask A representation of a unitary action on the record fields. #### Methods | **Name** | **Description** | | --- | --- | | bind | *No description.* | --- ##### `bind` ```typescript public bind(flow: IFlow, source: ISource): TaskProperty ``` ###### `flow`^Required - *Type:* IFlow --- ###### `source`^Required - *Type:* ISource --- ### ITransform - *Extends:* IOperation - *Implemented By:* Transform, ITransform A representation of a transform operation, that is an operation modifying source fields. ### IValidation - *Extends:* IOperation - *Implemented By:* Validation, IValidation A representation of a validation operation, that is an operation testing records and acting on the test results. ### IVertex - *Implemented By:* AmazonRdsForPostgreSqlDestination, AsanaSource, EventBridgeDestination, GoogleAdsSource, GoogleAnalytics4Source, GoogleBigQuerySource, HubSpotDestination, HubSpotSource, JdbcSmallDataScaleSource, MailchimpSource, MarketoSource, MicrosoftDynamics365Source, MicrosoftSharepointOnlineSource, RedshiftDestination, S3Destination, S3Source, SAPOdataDestination, SAPOdataSource, SalesforceDestination, SalesforceMarketingCloudSource, SalesforceSource, ServiceNowSource, SlackSource, SnowflakeDestination, ZendeskSource, IDestination, ISource, IVertex An interface representing a vertex, i.e. a source or a destination of an AppFlow flow. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectorType | ConnectorType | The AppFlow type of the connector that this source is implemented for. | --- ##### `connectorType`^Required ```typescript public readonly connectorType: ConnectorType; ``` - *Type:* ConnectorType The AppFlow type of the connector that this source is implemented for. --- ## Enums ### ConnectionMode #### Members | **Name** | **Description** | | --- | --- | | PUBLIC | *No description.* | | PRIVATE | *No description.* | --- ##### `PUBLIC` --- ##### `PRIVATE` --- ### ConnectorAuthenticationType #### Members | **Name** | **Description** | | --- | --- | | APIKEY | *No description.* | | BASIC | *No description.* | | CUSTOM | *No description.* | | OAUTH2 | *No description.* | --- ##### `APIKEY` --- ##### `BASIC` --- ##### `CUSTOM` --- ##### `OAUTH2` --- ### DataPullMode #### Members | **Name** | **Description** | | --- | --- | | COMPLETE | *No description.* | | INCREMENTAL | *No description.* | --- ##### `COMPLETE` --- ##### `INCREMENTAL` --- ### FlowStatus #### Members | **Name** | **Description** | | --- | --- | | ACTIVE | *No description.* | | SUSPENDED | *No description.* | --- ##### `ACTIVE` --- ##### `SUSPENDED` --- ### FlowType #### Members | **Name** | **Description** | | --- | --- | | EVENT | *No description.* | | ON_DEMAND | *No description.* | | SCHEDULED | *No description.* | --- ##### `EVENT` --- ##### `ON_DEMAND` --- ##### `SCHEDULED` --- ### GoogleAdsApiVersion An enum representing the GoogleAds API versions. #### Members | **Name** | **Description** | | --- | --- | | V16 | *No description.* | --- ##### `V16` --- ### GoogleAnalytics4ApiVersion #### Members | **Name** | **Description** | | --- | --- | | V1BETA | *No description.* | --- ##### `V1BETA` --- ### GoogleBigQueryApiVersion #### Members | **Name** | **Description** | | --- | --- | | V2 | *No description.* | --- ##### `V2` --- ### HubSpotApiVersion #### Members | **Name** | **Description** | | --- | --- | | V1 | *No description.* | | V2 | *No description.* | | V3 | *No description.* | | V4 | *No description.* | --- ##### `V1` --- ##### `V2` --- ##### `V3` --- ##### `V4` --- ### JdbcDriver #### Members | **Name** | **Description** | | --- | --- | | POSTGRES | *No description.* | | MYSQL | *No description.* | --- ##### `POSTGRES` --- ##### `MYSQL` --- ### MailchimpApiVersion An enum representing the Mailchimp API versions. #### Members | **Name** | **Description** | | --- | --- | | V3 | *No description.* | --- ##### `V3` --- ### MicrosoftDynamics365ApiVersion An enum representing the Microsoft Dynamics 365 API versions. #### Members | **Name** | **Description** | | --- | --- | | V9_2 | Version 9.2. | --- ##### `V9_2` Version 9.2. --- ### MicrosoftSharepointOnlineApiVersion An enum representing the Microsoft Sharepoint Online API versions. #### Members | **Name** | **Description** | | --- | --- | | V1 | Version 1.0. | --- ##### `V1` Version 1.0. --- ### OAuth2GrantType #### Members | **Name** | **Description** | | --- | --- | | CLIENT_CREDENTIALS | *No description.* | | AUTHORIZATION_CODE | *No description.* | --- ##### `CLIENT_CREDENTIALS` --- ##### `AUTHORIZATION_CODE` --- ### S3InputFileType The file type that Amazon AppFlow gets from your Amazon S3 bucket. #### Members | **Name** | **Description** | | --- | --- | | CSV | *No description.* | | JSON | *No description.* | --- ##### `CSV` --- ##### `JSON` --- ### S3OutputAggregationType #### Members | **Name** | **Description** | | --- | --- | | NONE | *No description.* | | SINGLE_FILE | *No description.* | --- ##### `NONE` --- ##### `SINGLE_FILE` --- ### S3OutputFilePrefixFormat #### Members | **Name** | **Description** | | --- | --- | | DAY | *No description.* | | HOUR | *No description.* | | MINUTE | *No description.* | | MONTH | *No description.* | | YEAR | *No description.* | --- ##### `DAY` --- ##### `HOUR` --- ##### `MINUTE` --- ##### `MONTH` --- ##### `YEAR` --- ### S3OutputFilePrefixHierarchy #### Members | **Name** | **Description** | | --- | --- | | EXECUTION_ID | *No description.* | | SCHEMA_VERSION | *No description.* | --- ##### `EXECUTION_ID` --- ##### `SCHEMA_VERSION` --- ### S3OutputFilePrefixType #### Members | **Name** | **Description** | | --- | --- | | FILENAME | *No description.* | | PATH | *No description.* | | PATH_AND_FILE | *No description.* | --- ##### `FILENAME` --- ##### `PATH` --- ##### `PATH_AND_FILE` --- ### S3OutputFileType Output file type supported by Amazon S3 Destination connector. #### Members | **Name** | **Description** | | --- | --- | | CSV | CSV file type. | | JSON | JSON file type. | | PARQUET | Parquet file type. | --- ##### `CSV` CSV file type. --- ##### `JSON` JSON file type. --- ##### `PARQUET` Parquet file type. --- ### SalesforceDataTransferApi The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers to Salesforce. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0. Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields. By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output. #### Members | **Name** | **Description** | | --- | --- | | AUTOMATIC | *No description.* | | BULKV2 | *No description.* | | REST_SYNC | *No description.* | --- ##### `AUTOMATIC` --- ##### `BULKV2` --- ##### `REST_SYNC` --- ### SalesforceMarketingCloudApiVersions A helper enum for SFMC api version. #### Members | **Name** | **Description** | | --- | --- | | V1 | *No description.* | --- ##### `V1` --- ### WriteOperationType #### Members | **Name** | **Description** | | --- | --- | | DELETE | *No description.* | | INSERT | *No description.* | | UPDATE | *No description.* | | UPSERT | *No description.* | --- ##### `DELETE` --- ##### `INSERT` --- ##### `UPDATE` --- ##### `UPSERT` ---