aws-cdk-lib/aws-stepfunctions/lib/states/choice.d.ts

Version 2 of the AWS Cloud Development Kit library

import { Construct } from 'constructs';
import { AssignableStateOptions, ChoiceTransitionOptions, JsonataCommonOptions, JsonPathCommonOptions, State, StateBaseProps } from './state';
import { Chain } from '../chain';
import { Condition } from '../condition';
import { IChainable, INextable, QueryLanguage } from '../types';
/**
 * Properties for defining a Choice state that using JSONPath
 */
export interface ChoiceJsonPathProps extends StateBaseProps, AssignableStateOptions, JsonPathCommonOptions {
}
/**
 * Properties for defining a Choice state that using JSONata
 */
export interface ChoiceJsonataProps extends StateBaseProps, AssignableStateOptions, JsonataCommonOptions {
}
/**
 * Properties for defining a Choice state
 */
export interface ChoiceProps extends StateBaseProps, AssignableStateOptions, JsonPathCommonOptions, JsonataCommonOptions {
}
/**
 * Define a Choice in the state machine
 *
 * A choice state can be used to make decisions based on the execution
 * state.
 */
export declare class Choice extends State {
    /**
     * Define a Choice using JSONPath in the state machine
     *
     * A choice state can be used to make decisions based on the execution
     * state.
     */
    static jsonPath(scope: Construct, id: string, props?: ChoiceJsonPathProps): Choice;
    /**
     * Define a Choice using JSONata in the state machine
     *
     * A choice state can be used to make decisions based on the execution
     * state.
     */
    static jsonata(scope: Construct, id: string, props?: ChoiceJsonataProps): Choice;
    readonly endStates: INextable[];
    constructor(scope: Construct, id: string, props?: ChoiceProps);
    /**
     * If the given condition matches, continue execution with the given state
     */
    when(condition: Condition, next: IChainable, options?: ChoiceTransitionOptions): Choice;
    /**
     * If none of the given conditions match, continue execution with the given state
     *
     * If no conditions match and no otherwise() has been given, an execution
     * error will be raised.
     */
    otherwise(def: IChainable): Choice;
    /**
     * Return a Chain that contains all reachable end states from this Choice
     *
     * Use this to combine all possible choice paths back.
     */
    afterwards(options?: AfterwardsOptions): Chain;
    /**
     * Return the Amazon States Language object for this state
     */
    toStateJson(topLevelQueryLanguage?: QueryLanguage): object;
}
/**
 * Options for selecting the choice paths
 */
export interface AfterwardsOptions {
    /**
     * Whether to include error handling states
     *
     * If this is true, all states which are error handlers (added through 'onError')
     * and states reachable via error handlers will be included as well.
     *
     * @default false
     */
    readonly includeErrorHandlers?: boolean;
    /**
     * Whether to include the default/otherwise transition for the current Choice state
     *
     * If this is true and the current Choice does not have a default outgoing
     * transition, one will be added included when .next() is called on the chain.
     *
     * @default false
     */
    readonly includeOtherwise?: boolean;
}