interface CallApiGatewayHttpApiEndpointProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Tasks.CallApiGatewayHttpApiEndpointProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#CallApiGatewayHttpApiEndpointProps |
![]() | software.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayHttpApiEndpointProps |
![]() | aws_cdk.aws_stepfunctions_tasks.CallApiGatewayHttpApiEndpointProps |
![]() | aws-cdk-lib » aws_stepfunctions_tasks » CallApiGatewayHttpApiEndpointProps |
Properties for calling an HTTP API Endpoint.
Example
import * as apigatewayv2 from 'aws-cdk-lib/aws-apigatewayv2';
const httpApi = new apigatewayv2.HttpApi(this, 'MyHttpApi');
const invokeTask = new tasks.CallApiGatewayHttpApiEndpoint(this, 'Call HTTP API', {
apiId: httpApi.apiId,
apiStack: Stack.of(httpApi),
method: tasks.HttpMethod.GET,
});
Properties
Name | Type | Description |
---|---|---|
api | string | The Id of the API to call. |
api | Stack | The Stack in which the API is defined. |
method | Http | Http method for the API. |
api | string | Path parameters appended after API endpoint. |
assign? | { [string]: any } | Workflow variables to store in this step. |
auth | Auth | Authentication methods. |
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 | HTTP request information that does not relate to contents of the request. |
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 | Query strings attatched to end of request. |
request | Task | HTTP Request body. |
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. |
stage | string | Name of the stage where the API is deployed to in API Gateway. |
state | string | Optional name for this state. |
task | Timeout | Timeout for the task. |
timeout? | Duration | Timeout for the task. |
apiId
Type:
string
The Id of the API to call.
apiStack
Type:
Stack
The Stack in which the API is defined.
method
Type:
Http
Http method for the API.
apiPath?
Type:
string
(optional, default: No path)
Path parameters appended after API endpoint.
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.
authType?
Type:
Auth
(optional, default: AuthType.NO_AUTH)
Authentication methods.
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 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: $)
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.
queryParameters?
Type:
Task
(optional, default: No query parameters)
Query strings attatched to end of request.
requestBody?
Type:
Task
(optional, default: No request body)
HTTP Request body.
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.
stageName?
Type:
string
(optional, default: '$default')
Name of the stage where the API is deployed to in API Gateway.
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.