@cdklabs/cdk-appflow
Version:
*Note:* this library is currently in technical preview.
34 lines (33 loc) • 1.23 kB
TypeScript
import { OnEventOptions, Rule } from "aws-cdk-lib/aws-events";
import { Construct } from "constructs";
import { FlowBase, FlowBaseProps, FlowProps, FlowStatus, IFlow } from "./flow-base";
export interface TriggeredFlowBaseProps extends FlowProps {
/**
* The status to set on the flow. Use this over {@link autoActivate}.
*/
readonly status?: FlowStatus;
/**
* @deprecated. This property is deprecated and will be removed in a future release. Use {@link status} instead
*/
readonly autoActivate?: boolean;
}
/**
* A base class for triggered flows.
*/
export declare abstract class TriggeredFlowBase extends FlowBase implements IFlow {
/**
*
* @param autoActivate - a boolean value indicating whether to automatically activate the flow.
* @param status - a {@link FlowStatus} value indicating the status to set on the flow.
* @returns
*/
protected static setStatus(autoActivate?: boolean, status?: FlowStatus): FlowStatus | undefined;
/**
*
* @param scope
* @param id
* @param props
*/
constructor(scope: Construct, id: string, props: FlowBaseProps);
abstract onDeactivated(id: string, options?: OnEventOptions): Rule;
}