Class HttpInvoke.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<HttpInvoke>
- Enclosing class:
HttpInvoke
HttpInvoke
.-
Method Summary
Modifier and TypeMethodDescriptionapiEndpoint
(TaskInput apiEndpoint) The API endpoint to call, relative toapiRoot
.Permissions are granted to call all resources under this path.Workflow variables to store in this step.The body to send to the HTTP endpoint.build()
A comment describing this state.connection
(IConnection connection) The EventBridge Connection to use for authentication.static HttpInvoke.Builder
credentials
(Credentials credentials) Credentials for an IAM Role that the State Machine assumes for executing the task.The headers to send to the HTTP endpoint.Deprecated.heartbeatTimeout
(Timeout heartbeatTimeout) Timeout for the heartbeat.JSONPath expression to select part of the state to be the input to this state.integrationPattern
(IntegrationPattern integrationPattern) AWS Step Functions integrates with services directly in the Amazon States Language.The HTTP method to use.outputPath
(String outputPath) JSONPath expression to select part of the state to be the output to this state.Used to specify and transform output from the state.queryLanguage
(QueryLanguage queryLanguage) The name of the query language used by the state.queryStringParameters
(TaskInput queryStringParameters) The query string parameters to send to the HTTP endpoint.resultPath
(String resultPath) JSONPath expression to indicate where to inject the state's output.resultSelector
(Map<String, ? extends Object> resultSelector) The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.Optional name for this state.taskTimeout
(Timeout taskTimeout) Timeout for the task.Deprecated.usetaskTimeout
urlEncodingFormat
(URLEncodingFormat urlEncodingFormat) Determines whether to apply URL encoding to the request body, and which array encoding format to use.
-
Method Details
-
create
@Stability(Stable) public static HttpInvoke.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- Descriptive identifier for this chainable. This parameter is required.- Returns:
- a new instance of
HttpInvoke.Builder
.
-
comment
A comment describing this state.Default: No comment
- Parameters:
comment
- A comment describing this state. This parameter is required.- Returns:
this
-
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-levelqueryLanguage
field.Default: - JSONPath
- Parameters:
queryLanguage
- The name of the query language used by the state. This parameter is required.- Returns:
this
-
stateName
Optional name for this state.Default: - The construct ID will be used as state name
- Parameters:
stateName
- Optional name for this state. This parameter is required.- Returns:
this
-
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)
- Parameters:
credentials
- Credentials for an IAM Role that the State Machine assumes for executing the task. This parameter is required.- Returns:
this
- See Also:
-
heartbeat
Deprecated.useheartbeatTimeout
(deprecated) Timeout for the heartbeat.Default: - None
- Parameters:
heartbeat
- Timeout for the heartbeat. This parameter is required.- Returns:
this
-
heartbeatTimeout
Timeout for the heartbeat.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Parameters:
heartbeatTimeout
- Timeout for the heartbeat. This parameter is required.- Returns:
this
-
integrationPattern
@Stability(Stable) public HttpInvoke.Builder integrationPattern(IntegrationPattern 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`.
- Parameters:
integrationPattern
- AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.- Returns:
this
- See Also:
-
taskTimeout
Timeout for the task.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Parameters:
taskTimeout
- Timeout for the task. This parameter is required.- Returns:
this
-
timeout
Deprecated.usetaskTimeout
(deprecated) Timeout for the task.Default: - None
- Parameters:
timeout
- Timeout for the task. This parameter is required.- Returns:
this
-
assign
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
- Parameters:
assign
- Workflow variables to store in this step. This parameter is required.- Returns:
this
- See Also:
-
inputPath
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: $
- Parameters:
inputPath
- JSONPath expression to select part of the state to be the input to this state. This parameter is required.- Returns:
this
-
outputPath
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: $
- Parameters:
outputPath
- JSONPath expression to select part of the state to be the output to this state. This parameter is required.- Returns:
this
-
outputs
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
- Parameters:
outputs
- Used to specify and transform output from the state. This parameter is required.- Returns:
this
- See Also:
-
resultPath
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: $
- Parameters:
resultPath
- JSONPath expression to indicate where to inject the state's output. This parameter is required.- Returns:
this
-
resultSelector
@Stability(Stable) public HttpInvoke.Builder resultSelector(Map<String, ? extends Object> resultSelector) 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
- Parameters:
resultSelector
- The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.- Returns:
this
- See Also:
-
apiEndpoint
The API endpoint to call, relative toapiRoot
.Example:
TaskInput.fromText("path/to/resource");
- Parameters:
apiEndpoint
- The API endpoint to call, relative toapiRoot
. This parameter is required.- Returns:
this
-
apiRoot
Permissions are granted to call all resources under this path.Example:
"https://api.example.com";
- Parameters:
apiRoot
- Permissions are granted to call all resources under this path. This parameter is required.- Returns:
this
-
connection
The EventBridge Connection to use for authentication.- Parameters:
connection
- The EventBridge Connection to use for authentication. This parameter is required.- Returns:
this
-
method
The HTTP method to use.Example:
TaskInput.fromText("GET");
- Parameters:
method
- The HTTP method to use. This parameter is required.- Returns:
this
-
body
The body to send to the HTTP endpoint.Default: - No body is sent with the request.
- Parameters:
body
- The body to send to the HTTP endpoint. This parameter is required.- Returns:
this
-
headers
The headers to send to the HTTP endpoint.Default: - No additional headers are added to the request.
Example:
TaskInput.fromObject(Map.of("Content-Type", "application/json"));
- Parameters:
headers
- The headers to send to the HTTP endpoint. This parameter is required.- Returns:
this
-
queryStringParameters
The query string parameters to send to the HTTP endpoint.Default: - No query string parameters are sent in the request.
- Parameters:
queryStringParameters
- The query string parameters to send to the HTTP endpoint. This parameter is required.- Returns:
this
-
urlEncodingFormat
Determines whether to apply URL encoding to the request body, and which array encoding format to use.URLEncodingFormat.NONE
passes the JSON-serializedRequestBody
field as the HTTP request body. Otherwise, the HTTP request body is the URL-encoded form data of theRequestBody
field using the specified array encoding format, and theContent-Type
header is set toapplication/x-www-form-urlencoded
.Default: - URLEncodingFormat.NONE
- Parameters:
urlEncodingFormat
- Determines whether to apply URL encoding to the request body, and which array encoding format to use. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<HttpInvoke>
- Returns:
- a newly built instance of
HttpInvoke
.
-
heartbeatTimeout