interface HttpInvokeProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Tasks.HttpInvokeProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#HttpInvokeProps |
![]() | software.amazon.awscdk.services.stepfunctions.tasks.HttpInvokeProps |
![]() | aws_cdk.aws_stepfunctions_tasks.HttpInvokeProps |
![]() | 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 |
---|---|---|
api | Task | The API endpoint to call, relative to apiRoot . |
api | string | Permissions are granted to call all resources under this path. |
connection | IConnection | The EventBridge Connection to use for authentication. |
method | Task | The HTTP method to use. |
assign? | { [string]: any } | Workflow variables to store in this step. |
body? | Task | The body to send to the HTTP endpoint. |
comment? | string | A comment describing this state. |
credentials? | Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
headers? | Task | The headers to send to the HTTP endpoint. |
heartbeat? | Duration | Timeout for the heartbeat. |
heartbeat | Timeout | Timeout for the heartbeat. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
integration | Integration | AWS Step Functions integrates with services directly in the Amazon States Language. |
output | string | JSONPath expression to select part of the state to be the output to this state. |
outputs? | any | Used to specify and transform output from the state. |
query | Query | The name of the query language used by the state. |
query | Task | The query string parameters to send to the HTTP endpoint. |
result | string | JSONPath expression to indicate where to inject the state's output. |
result | { [string]: any } | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
state | string | Optional name for this state. |
task | Timeout | Timeout for the task. |
timeout? | Duration | Timeout for the task. |
url | URLEncoding | Determines whether to apply URL encoding to the request body, and which array encoding format to use. |
apiEndpoint
Type:
Task
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:
Task
The HTTP method to use. Example
sfn.TaskInput.fromText('GET')
assign?
Type:
{ [string]: any }
(optional, default: Not assign variables)
Workflow variables to store in this step.
Using workflow variables, you can store data in a step and retrieve that data in future steps.
body?
Type:
Task
(optional, default: No body is sent with the request.)
The body to send to the HTTP endpoint.
comment?
Type:
string
(optional, default: No comment)
A comment describing 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.
headers?
Type:
Task
(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: $)
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:
Integration
(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.
outputPath?
Type:
string
(optional, default: $)
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?
Type:
any
(optional, default: $states.result or $states.errorOutput)
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.
queryLanguage?
Type:
Query
(optional, default: JSONPath)
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.
queryStringParameters?
Type:
Task
(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: $)
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.
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:
URLEncoding
(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
.