Class HttpInvokeProps.Jsii$Proxy
- All Implemented Interfaces:
HttpInvokeProps
,TaskStateBaseProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
HttpInvokeProps
HttpInvokeProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.tasks.HttpInvokeProps
HttpInvokeProps.Builder, HttpInvokeProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(HttpInvokeProps.Builder builder) Constructor that initializes the object based on literal property values passed by theHttpInvokeProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final TaskInput
The API endpoint to call, relative toapiRoot
.final String
Permissions are granted to call all resources under this path.final TaskInput
getBody()
The body to send to the HTTP endpoint.final String
An optional description for this state.final IConnection
The EventBridge Connection to use for authentication.final Credentials
Credentials for an IAM Role that the State Machine assumes for executing the task.final TaskInput
The headers to send to the HTTP endpoint.final Duration
(deprecated) Timeout for the heartbeat.final Timeout
Timeout for the heartbeat.final String
JSONPath expression to select part of the state to be the input to this state.final IntegrationPattern
AWS Step Functions integrates with services directly in the Amazon States Language.final TaskInput
The HTTP method to use.final String
JSONPath expression to select select a portion of the state output to pass to the next state.final TaskInput
The query string parameters to send to the HTTP endpoint.final String
JSONPath expression to indicate where to inject the state's output.The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.final String
Optional name for this state.final Timeout
Timeout for the task.final Duration
(deprecated) Timeout for the task.final URLEncodingFormat
Determines whether to apply URL encoding to the request body, and which array encoding format to use.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theHttpInvokeProps.Builder
.
-
-
Method Details
-
getApiEndpoint
Description copied from interface:HttpInvokeProps
The API endpoint to call, relative toapiRoot
.Example:
TaskInput.fromText("path/to/resource");
- Specified by:
getApiEndpoint
in interfaceHttpInvokeProps
-
getApiRoot
Description copied from interface:HttpInvokeProps
Permissions are granted to call all resources under this path.Example:
"https://api.example.com";
- Specified by:
getApiRoot
in interfaceHttpInvokeProps
-
getConnection
Description copied from interface:HttpInvokeProps
The EventBridge Connection to use for authentication.- Specified by:
getConnection
in interfaceHttpInvokeProps
-
getMethod
Description copied from interface:HttpInvokeProps
The HTTP method to use.Example:
TaskInput.fromText("GET");
- Specified by:
getMethod
in interfaceHttpInvokeProps
-
getBody
Description copied from interface:HttpInvokeProps
The body to send to the HTTP endpoint.Default: - No body is sent with the request.
- Specified by:
getBody
in interfaceHttpInvokeProps
-
getHeaders
Description copied from interface:HttpInvokeProps
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"));
- Specified by:
getHeaders
in interfaceHttpInvokeProps
-
getQueryStringParameters
Description copied from interface:HttpInvokeProps
The query string parameters to send to the HTTP endpoint.Default: - No query string parameters are sent in the request.
- Specified by:
getQueryStringParameters
in interfaceHttpInvokeProps
-
getUrlEncodingFormat
Description copied from interface:HttpInvokeProps
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
- Specified by:
getUrlEncodingFormat
in interfaceHttpInvokeProps
-
getComment
Description copied from interface:TaskStateBaseProps
An optional description for this state.Default: - No comment
- Specified by:
getComment
in interfaceTaskStateBaseProps
-
getCredentials
Description copied from interface:TaskStateBaseProps
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)
- Specified by:
getCredentials
in interfaceTaskStateBaseProps
- See Also:
-
getHeartbeat
Description copied from interface:TaskStateBaseProps
(deprecated) Timeout for the heartbeat.Default: - None
- Specified by:
getHeartbeat
in interfaceTaskStateBaseProps
-
getHeartbeatTimeout
Description copied from interface:TaskStateBaseProps
Timeout for the heartbeat.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Specified by:
getHeartbeatTimeout
in interfaceTaskStateBaseProps
-
getInputPath
Description copied from interface:TaskStateBaseProps
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: - The entire task input (JSON path '$')
- Specified by:
getInputPath
in interfaceTaskStateBaseProps
-
getIntegrationPattern
Description copied from interface:TaskStateBaseProps
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`.
- Specified by:
getIntegrationPattern
in interfaceTaskStateBaseProps
- See Also:
-
getOutputPath
Description copied from interface:TaskStateBaseProps
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 {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
- Specified by:
getOutputPath
in interfaceTaskStateBaseProps
-
getResultPath
Description copied from interface:TaskStateBaseProps
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: - Replaces the entire input with the result (JSON path '$')
- Specified by:
getResultPath
in interfaceTaskStateBaseProps
-
getResultSelector
Description copied from interface:TaskStateBaseProps
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
- Specified by:
getResultSelector
in interfaceTaskStateBaseProps
- See Also:
-
getStateName
Description copied from interface:TaskStateBaseProps
Optional name for this state.Default: - The construct ID will be used as state name
- Specified by:
getStateName
in interfaceTaskStateBaseProps
-
getTaskTimeout
Description copied from interface:TaskStateBaseProps
Timeout for the task.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Specified by:
getTaskTimeout
in interfaceTaskStateBaseProps
-
getTimeout
Description copied from interface:TaskStateBaseProps
(deprecated) Timeout for the task.Default: - None
- Specified by:
getTimeout
in interfaceTaskStateBaseProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-