GradientEdge CDK Utils
    Preparing search index...

    Interface SfnCallApiGatewayRestApiEndpointProps

    interface SfnCallApiGatewayRestApiEndpointProps {
        api: IRestApi;
        apiPath?: string;
        assign?: { [name: string]: any };
        authType?: AuthType;
        comment?: string;
        credentials?: Credentials;
        headers?: TaskInput;
        heartbeat?: Duration;
        heartbeatTimeout?: Timeout;
        inputPath?: string;
        integrationPattern?: IntegrationPattern;
        method: HttpMethod;
        name: string;
        outputPath?: string;
        outputs?: any;
        queryLanguage?: QueryLanguage;
        queryParameters?: TaskInput;
        region?: string;
        requestBody?: TaskInput;
        resultPath?: string;
        resultSelector?: { [key: string]: any };
        retries?: SfnRetryProps[];
        stageName: string;
        stateName?: string;
        taskTimeout?: Timeout;
        timeout?: Duration;
    }

    Hierarchy

    • CallApiGatewayRestApiEndpointProps
      • SfnCallApiGatewayRestApiEndpointProps
    Index

    Properties

    api apiPath? assign? authType? comment? credentials? headers? heartbeat? heartbeatTimeout? inputPath? integrationPattern? method name outputPath? outputs? queryLanguage? queryParameters? region? requestBody? resultPath? resultSelector? retries? stageName stateName? taskTimeout? timeout?

    Properties

    api: IRestApi

    API to call

    apiPath?: string

    Path parameters appended after API endpoint

    - No path
    assign?: { [name: string]: any }

    Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

    https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

    - Not assign variables
    authType?: AuthType

    Authentication methods

    AuthType.NO_AUTH
    comment?: string

    A comment describing this state

    No comment
    credentials?: Credentials

    Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

    https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

    - None (Task is executed using the State Machine's execution role)
    headers?: TaskInput

    HTTP request information that does not relate to contents of the request

    - No headers
    heartbeat?: Duration

    Timeout for the heartbeat

    - None

    use heartbeatTimeout

    heartbeatTimeout?: Timeout

    Timeout for the heartbeat

    [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

    - None
    inputPath?: string

    JSONPath expression to select part of the state to be the input to this state.

    May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

    $
    integrationPattern?: IntegrationPattern

    AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns.

    Depending on the AWS Service, the Service Integration Pattern availability will vary.

    https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

    • IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.
    method: HttpMethod

    Http method for the API

    name: string
    outputPath?: string

    JSONPath expression to select part of the state to be the output to this state.

    May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

    $
    outputs?: any

    Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

    https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

    - $states.result or $states.errorOutput
    queryLanguage?: QueryLanguage

    The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

    - JSONPath
    queryParameters?: TaskInput

    Query strings attached to end of request

    - No query parameters
    region?: string

    Specify a custom Region where the API is deployed, e.g. 'us-east-1'.

    • Uses the Region of the stack containing the api.
    requestBody?: TaskInput

    HTTP Request body

    - No request body
    resultPath?: string

    JSONPath expression to indicate where to inject the state's output

    May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

    $
    resultSelector?: { [key: string]: any }

    The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

    You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

    https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

    - None
    retries?: SfnRetryProps[]
    stageName: string

    Name of the stage where the API is deployed to in API Gateway

    stateName?: string

    Optional name for this state

    - The construct ID will be used as state name
    taskTimeout?: Timeout

    Timeout for the task

    [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

    - None
    timeout?: Duration

    Timeout for the task

    - None

    use taskTimeout

    Settings

    Member Visibility

    On This Page

    Properties