interface HttpInvokeProps

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.Tasks.HttpInvokeProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#HttpInvokeProps
Java	software.amazon.awscdk.services.stepfunctions.tasks.HttpInvokeProps
Python	aws_cdk.aws_stepfunctions_tasks.HttpInvokeProps
TypeScript (source)	aws-cdk-lib » aws_stepfunctions_tasks » HttpInvokeProps

Properties for calling an external HTTP endpoint with HttpInvoke.

Example

import * as events from 'aws-cdk-lib/aws-events';

const connection = new events.Connection(this, 'Connection', {
  authorization: events.Authorization.basic('username', SecretValue.unsafePlainText('password')),
});

new tasks.HttpInvoke(this, 'Invoke HTTP API', {
  apiRoot: 'https://api.example.com',
  apiEndpoint: sfn.TaskInput.fromText('path/to/resource'),
  body: sfn.TaskInput.fromObject({ foo: 'bar' }),
  connection,
  headers: sfn.TaskInput.fromObject({ 'Content-Type': 'application/json' }),
  method: sfn.TaskInput.fromText('POST'),
  queryStringParameters: sfn.TaskInput.fromObject({ id: '123' }),
  urlEncodingFormat: tasks.URLEncodingFormat.BRACKETS,
});

Properties

Name	Type	Description
apiEndpoint	TaskInput	The API endpoint to call, relative to apiRoot.
apiRoot	string	Permissions are granted to call all resources under this path.
connection	IConnection	The EventBridge Connection to use for authentication.
method	TaskInput	The HTTP method to use.
body?	TaskInput	The body to send to the HTTP endpoint.
comment?	string	An optional description for this state.
credentials?	Credentials	Credentials for an IAM Role that the State Machine assumes for executing the task.
headers?	TaskInput	The headers to send to the HTTP endpoint.
heartbeat?⚠️	Duration	Timeout for the heartbeat.
heartbeatTimeout?	Timeout	Timeout for the heartbeat.
inputPath?	string	JSONPath expression to select part of the state to be the input to this state.
integrationPattern?	IntegrationPattern	AWS Step Functions integrates with services directly in the Amazon States Language.
outputPath?	string	JSONPath expression to select select a portion of the state output to pass to the next state.
queryStringParameters?	TaskInput	The query string parameters to send to the HTTP endpoint.
resultPath?	string	JSONPath 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.
stateName?	string	Optional name for this state.
taskTimeout?	Timeout	Timeout for the task.
timeout?⚠️	Duration	Timeout for the task.
urlEncodingFormat?	URLEncodingFormat	Determines whether to apply URL encoding to the request body, and which array encoding format to use.

---

apiEndpoint

Type: TaskInput

The API endpoint to call, relative to apiRoot. Example

sfn.TaskInput.fromText('path/to/resource')

---

apiRoot

Type: string

Permissions are granted to call all resources under this path. Example

'https://api.example.com'

---

connection

Type: IConnection

The EventBridge Connection to use for authentication.

---

method

Type: TaskInput

The HTTP method to use. Example

sfn.TaskInput.fromText('GET')

---

body?

Type: TaskInput (optional, default: No body is sent with the request.)

The body to send to the HTTP endpoint.

---

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 additional headers are added to the request.)

The headers to send to the HTTP endpoint. Example

sfn.TaskInput.fromObject({ 'Content-Type': 'application/json' })

---

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.

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

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

---

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

---

queryStringParameters?

Type: TaskInput (optional, default: No query string parameters are sent in the request.)

The query string parameters to send to the HTTP endpoint.

---

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

---

stateName?

Type: string (optional, default: The construct ID will be used as state name)

Optional name for this state.

---

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.

---

urlEncodingFormat?

Type: URLEncodingFormat (optional, default: URLEncodingFormat.NONE)

Determines whether to apply URL encoding to the request body, and which array encoding format to use.

URLEncodingFormat.NONE passes the JSON-serialized RequestBody field as the HTTP request body. Otherwise, the HTTP request body is the URL-encoded form data of the RequestBody field using the specified array encoding format, and the Content-Type header is set to application/x-www-form-urlencoded.