Package software.amazon.awscdk.services.stepfunctions.tasks

Class HttpInvokeProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.tasks.HttpInvokeProps.Jsii$Proxy

All Implemented Interfaces:

AssignableStateOptions, JsonataCommonOptions, JsonPathCommonOptions, StateBaseProps, HttpInvokeProps, TaskStateBaseOptions, TaskStateBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

HttpInvokeProps

@Stability(Stable)
@Internal
public static final class HttpInvokeProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements HttpInvokeProps

An implementation for 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

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(HttpInvokeProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the HttpInvokeProps.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 Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final TaskInput	getApiEndpoint()	The API endpoint to call, relative to apiRoot.
final String	getApiRoot()	Permissions are granted to call all resources under this path.
final Map<String,Object>	getAssign()	Workflow variables to store in this step.
final TaskInput	getBody()	The body to send to the HTTP endpoint.
final String	getComment()	A comment describing this state.
final IConnection	getConnection()	The EventBridge Connection to use for authentication.
final Credentials	getCredentials()	Credentials for an IAM Role that the State Machine assumes for executing the task.
final TaskInput	getHeaders()	The headers to send to the HTTP endpoint.
final Duration	getHeartbeat()	(deprecated) Timeout for the heartbeat.
final Timeout	getHeartbeatTimeout()	Timeout for the heartbeat.
final String	getInputPath()	JSONPath expression to select part of the state to be the input to this state.
final IntegrationPattern	getIntegrationPattern()	AWS Step Functions integrates with services directly in the Amazon States Language.
final TaskInput	getMethod()	The HTTP method to use.
final String	getOutputPath()	JSONPath expression to select part of the state to be the output to this state.
final Object	getOutputs()	Used to specify and transform output from the state.
final QueryLanguage	getQueryLanguage()	The name of the query language used by the state.
final TaskInput	getQueryStringParameters()	The query string parameters to send to the HTTP endpoint.
final String	getResultPath()	JSONPath expression to indicate where to inject the state's output.
final Map<String,Object>	getResultSelector()	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
final String	getStateName()	Optional name for this state.
final Timeout	getTaskTimeout()	Timeout for the task.
final Duration	getTimeout()	(deprecated) Timeout for the task.
final URLEncodingFormat	getUrlEncodingFormat()	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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

protected Jsii$Proxy(HttpInvokeProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the HttpInvokeProps.Builder.

Method Details

getApiEndpoint

public final TaskInput getApiEndpoint()

Description copied from interface: HttpInvokeProps

The API endpoint to call, relative to apiRoot.

Example:

 TaskInput.fromText("path/to/resource");
 

Specified by:

getApiEndpoint in interface HttpInvokeProps

getApiRoot

public final String 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 interface HttpInvokeProps

getConnection

public final IConnection getConnection()

Description copied from interface: HttpInvokeProps

The EventBridge Connection to use for authentication.

Specified by:

getConnection in interface HttpInvokeProps

getMethod

public final TaskInput getMethod()

Description copied from interface: HttpInvokeProps

The HTTP method to use.

Example:

 TaskInput.fromText("GET");
 

Specified by:

getMethod in interface HttpInvokeProps

getBody

public final TaskInput 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 interface HttpInvokeProps

getHeaders

public final TaskInput 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 interface HttpInvokeProps

getQueryStringParameters

public final TaskInput 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 interface HttpInvokeProps

getUrlEncodingFormat

public final URLEncodingFormat 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-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.

Default: - URLEncodingFormat.NONE

Specified by:

getUrlEncodingFormat in interface HttpInvokeProps

getResultPath

public final String 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: $

Specified by:

getResultPath in interface TaskStateBaseProps

getResultSelector

public final Map<String,Object> 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 interface TaskStateBaseProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

getComment

public final String getComment()

Description copied from interface: StateBaseProps

A comment describing this state.

Default: No comment

Specified by:

getComment in interface StateBaseProps

getQueryLanguage

public final QueryLanguage getQueryLanguage()

Description copied from interface: StateBaseProps

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.

Default: - JSONPath

Specified by:

getQueryLanguage in interface StateBaseProps

getStateName

public final String getStateName()

Description copied from interface: StateBaseProps

Optional name for this state.

Default: - The construct ID will be used as state name

Specified by:

getStateName in interface StateBaseProps

getCredentials

public final Credentials getCredentials()

Description copied from interface: TaskStateBaseOptions

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 interface TaskStateBaseOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

getHeartbeat

public final Duration getHeartbeat()

Description copied from interface: TaskStateBaseOptions

(deprecated) Timeout for the heartbeat.

Default: - None

Specified by:

getHeartbeat in interface TaskStateBaseOptions

getHeartbeatTimeout

public final Timeout getHeartbeatTimeout()

Description copied from interface: TaskStateBaseOptions

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 interface TaskStateBaseOptions

getIntegrationPattern

public final IntegrationPattern getIntegrationPattern()

Description copied from interface: TaskStateBaseOptions

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 interface TaskStateBaseOptions

See Also:

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

getTaskTimeout

public final Timeout getTaskTimeout()

Description copied from interface: TaskStateBaseOptions

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 interface TaskStateBaseOptions

getTimeout

public final Duration getTimeout()

Description copied from interface: TaskStateBaseOptions

(deprecated) Timeout for the task.

Default: - None

Specified by:

getTimeout in interface TaskStateBaseOptions

getAssign

public final Map<String,Object> getAssign()

Description copied from interface: AssignableStateOptions

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

Specified by:

getAssign in interface AssignableStateOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

getInputPath

public final String getInputPath()

Description copied from interface: JsonPathCommonOptions

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: $

Specified by:

getInputPath in interface JsonPathCommonOptions

getOutputPath

public final String getOutputPath()

Description copied from interface: JsonPathCommonOptions

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: $

Specified by:

getOutputPath in interface JsonPathCommonOptions

getOutputs

public final Object getOutputs()

Description copied from interface: JsonataCommonOptions

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

Specified by:

getOutputs in interface JsonataCommonOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object