L2 Construct

CallApiGatewayRestApiEndpoint

Call REST API endpoint as a Task. Be aware that the header values must be arrays. When passing the Task Token in the headers field `WAIT_FOR_TASK_TOKEN` integration, use `JsonPath.array()` to wrap the token in an array: ```ts import * as apigateway from 'aws-cdk-lib/aws-apigateway'; declare const api: apigateway.RestApi; new tasks.CallApiGatewayRestApiEndpoint(this, 'Endpoint', { api, stageName: 'Stage', method: tasks.HttpMethod.PUT, integrationPattern: sfn.IntegrationPattern.WAIT_FOR_TASK_TOKEN, headers: sfn.TaskInput.fromObject({ TaskToken: sfn.JsonPath.array(sfn.JsonPath.taskToken), }), }); ```

Import

import { CallApiGatewayRestApiEndpoint } from 'aws-cdk-lib/aws-stepfunctions-tasks';

Or use the module namespace:

import * as stepfunctions_tasks from 'aws-cdk-lib/aws-stepfunctions-tasks';
// stepfunctions_tasks.CallApiGatewayRestApiEndpoint

Properties

Configuration passed to the constructor as CallApiGatewayRestApiEndpointProps.

2 properties inherited from TaskStateBaseProps

resultPathOptionalinherited from TaskStateBaseProps

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.

Default: $

resultSelectorOptionalinherited from TaskStateBaseProps

{ [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.

Default: - None

3 properties inherited from StateBaseProps

commentOptionalinherited from StateBaseProps

string

A comment describing this state.

Default: No comment

queryLanguageOptionalinherited from StateBaseProps

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.

Default: - JSONPath

stateNameOptionalinherited from StateBaseProps

string

Optional name for this state.

Default: - The construct ID will be used as state name

6 properties inherited from TaskStateBaseOptions

credentialsOptionalinherited from TaskStateBaseOptions

Credentials

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

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

heartbeatOptionalDeprecatedinherited from TaskStateBaseOptions

Duration

Timeout for the heartbeat.

Default: - None

Deprecated: use `heartbeatTimeout`

heartbeatTimeoutOptionalinherited from TaskStateBaseOptions

Timeout

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

Default: - None

integrationPatternOptionalinherited from TaskStateBaseOptions

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.

Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

taskTimeoutOptionalinherited from TaskStateBaseOptions

Timeout

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

Default: - None

timeoutOptionalDeprecatedinherited from TaskStateBaseOptions

Duration

Timeout for the task.

Default: - None

Deprecated: use `taskTimeout`

1 property inherited from AssignableStateOptions

assignOptionalinherited from AssignableStateOptions

{ [key: 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.

Default: - Not assign variables

2 properties inherited from JsonPathCommonOptions

inputPathOptionalinherited from JsonPathCommonOptions

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 {}.

Default: $

outputPathOptionalinherited from JsonPathCommonOptions

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 {}.

Default: $

1 property inherited from JsonataCommonOptions

outputsOptionalinherited from JsonataCommonOptions

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.

Default: - $states.result or $states.errorOutput

6 properties inherited from CallApiGatewayEndpointBaseOptions

methodRequiredinherited from CallApiGatewayEndpointBaseOptions

HttpMethod

Http method for the API.

apiPathOptionalinherited from CallApiGatewayEndpointBaseOptions

string

Path parameters appended after API endpoint.

Default: - No path

authTypeOptionalinherited from CallApiGatewayEndpointBaseOptions

AuthType

Authentication methods.

Default: AuthType.NO_AUTH

headersOptionalinherited from CallApiGatewayEndpointBaseOptions

TaskInput

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

Default: - No headers

queryParametersOptionalinherited from CallApiGatewayEndpointBaseOptions

TaskInput

Query strings attached to end of request.

Default: - No query parameters

requestBodyOptionalinherited from CallApiGatewayEndpointBaseOptions

TaskInput

HTTP Request body.

Default: - No request body

3 properties inherited from CallApiGatewayRestApiEndpointOptions

apiRequiredinherited from CallApiGatewayRestApiEndpointOptions

IRestApi

API to call.

stageNameRequiredinherited from CallApiGatewayRestApiEndpointOptions

string

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

regionOptionalinherited from CallApiGatewayRestApiEndpointOptions

string

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

Default: - Uses the Region of the stack containing the `api`.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL2 (Higher-level)

Moduleaws-stepfunctions-tasks

Properties24

Related Constructs

External Links

CDK API Documentation