aws-ddk-core/lib/stages/appflow-ingestion.d.ts

The AWS DataOps Development Kit is an open source development framework for customers that build data workflows and modern data architecture on AWS.

import { Duration } from "aws-cdk-lib";
import * as appflow from "aws-cdk-lib/aws-appflow";
import * as events from "aws-cdk-lib/aws-events";
import * as sfn from "aws-cdk-lib/aws-stepfunctions";
import * as tasks from "aws-cdk-lib/aws-stepfunctions-tasks";
import { Construct } from "constructs";
import { StateMachineStage, StateMachineStageProps } from "../pipelines/stage";
/**
 * Properties of the AppFlow Ingestion stage.
 */
export interface AppFlowIngestionStageProps extends StateMachineStageProps {
    /**
     * Name of the AppFlow flow to run. If None, an AppFlow flow is created.
     */
    readonly flowName?: string;
    /**
     * Time to wait between flow execution status checks.
     * @default aws_cdk.Duration.seconds(15)
     */
    readonly flowExecutionStatusCheckPeriod?: Duration;
    /**
     * The flow `appflow.CfnFlow.DestinationFlowConfigProperty` properties.
     */
    readonly destinationFlowConfig?: appflow.CfnFlow.DestinationFlowConfigProperty;
    /**
     * The flow `appflow.CfnFlow.SourceFlowConfigProperty` properties.
     */
    readonly sourceFlowConfig?: appflow.CfnFlow.SourceFlowConfigProperty;
    /**
     * The flow tasks properties.
     */
    readonly flowTasks?: appflow.CfnFlow.TaskProperty[];
}
/**
 * Stage that contains a step function that runs an AppFlow flow ingestion.
 * If the AppFlow flow name is not supplied, then the flow is created.
 */
export declare class AppFlowIngestionStage extends StateMachineStage {
    readonly targets?: events.IRuleTarget[];
    readonly eventPattern?: events.EventPattern;
    readonly stateMachine: sfn.StateMachine;
    readonly flowObject: tasks.CallAwsService;
    readonly flowName: string;
    /**
     * Constructs AppFlowIngestionStage.
     * @param scope Scope within which this construct is defined.
     * @param id Identifier of the stage.
     * @param props Properties for the stage.
     */
    constructor(scope: Construct, id: string, props: AppFlowIngestionStageProps);
    private createStartFlowCustomTask;
    private createCheckFlowExecutionTask;
}