aws-cdk-lib.aws_stepfunctions_tasks.CallApiGatewayRestApiEndpointProps

interface CallApiGatewayRestApiEndpointProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.Tasks.CallApiGatewayRestApiEndpointProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#CallApiGatewayRestApiEndpointProps
Javasoftware.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayRestApiEndpointProps
Pythonaws_cdk.aws_stepfunctions_tasks.CallApiGatewayRestApiEndpointProps
TypeScript (source)aws-cdk-lib » aws_stepfunctions_tasks » CallApiGatewayRestApiEndpointProps

Properties for calling an REST API Endpoint.

Example

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),
  }),
});

Properties

NameTypeDescription
apiIRestApiAPI to call.
methodHttpMethodHttp method for the API.
stageNamestringName of the stage where the API is deployed to in API Gateway.
apiPath?stringPath parameters appended after API endpoint.
authType?AuthTypeAuthentication methods.
comment?stringAn optional description for this state.
credentials?CredentialsCredentials for an IAM Role that the State Machine assumes for executing the task.
headers?TaskInputHTTP request information that does not relate to contents of the request.
heartbeat?⚠️DurationTimeout for the heartbeat.
heartbeatTimeout?TimeoutTimeout for the heartbeat.
inputPath?stringJSONPath expression to select part of the state to be the input to this state.
integrationPattern?IntegrationPatternAWS Step Functions integrates with services directly in the Amazon States Language.
outputPath?stringJSONPath expression to select select a portion of the state output to pass to the next state.
queryParameters?TaskInputQuery strings attatched to end of request.
requestBody?TaskInputHTTP Request body.
resultPath?stringJSONPath expression to indicate where to inject the state's output.
resultSelector?{ [string]: any }The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
taskTimeout?TimeoutTimeout for the task.
timeout?⚠️DurationTimeout for the task.

api

Type: IRestApi

API to call.


method

Type: HttpMethod

Http method for the API.


stageName

Type: string

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


apiPath?

Type: string (optional, default: No path)

Path parameters appended after API endpoint.


authType?

Type: AuthType (optional, default: AuthType.NO_AUTH)

Authentication methods.


comment?

Type: string (optional, default: No comment)

An optional description for this state.


credentials?

Type: Credentials (optional, default: None (Task is executed using the State Machine's execution role))

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

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


headers?

Type: TaskInput (optional, default: No headers)

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


heartbeat?⚠️

⚠️ Deprecated: use heartbeatTimeout

Type: Duration (optional, default: None)

Timeout for the heartbeat.


heartbeatTimeout?

Type: Timeout (optional, default: None)

Timeout for the heartbeat.

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


inputPath?

Type: string (optional, default: The entire task input (JSON path '$'))

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?

Type: IntegrationPattern (optional, default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.)

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token


outputPath?

Type: string (optional, default: The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$'))

JSONPath expression to select select a portion of the state output to pass to the next state.

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


queryParameters?

Type: TaskInput (optional, default: No query parameters)

Query strings attatched to end of request.


requestBody?

Type: TaskInput (optional, default: No request body)

HTTP Request body.


resultPath?

Type: string (optional, default: Replaces the entire input with the result (JSON path '$'))

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?

Type: { [string]: any } (optional, default: None)

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.

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


taskTimeout?

Type: Timeout (optional, default: None)

Timeout for the task.

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


timeout?⚠️

⚠️ Deprecated: use taskTimeout

Type: Duration (optional, default: None)

Timeout for the task.