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:
HttpInvokeProps, 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

  • 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

    • getComment

      public final String getComment()
      Description copied from interface: TaskStateBaseProps
      An optional description for this state.

      Default: - No comment

      Specified by:
      getComment in interface TaskStateBaseProps

    • getCredentials

      public final Credentials 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 interface TaskStateBaseProps
      See Also:

    • getHeartbeat

      public final Duration getHeartbeat()
      Description copied from interface: TaskStateBaseProps
      (deprecated) Timeout for the heartbeat.

      Default: - None

      Specified by:
      getHeartbeat in interface TaskStateBaseProps

    • getHeartbeatTimeout

      public final Timeout 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 interface TaskStateBaseProps

    • getInputPath

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

    • getIntegrationPattern

      public final IntegrationPattern 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 interface TaskStateBaseProps
      See Also:

    • getOutputPath

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

    • 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: - Replaces the entire input with the result (JSON path '$')

      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:

    • getStateName

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

    • getTaskTimeout

      public final Timeout 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 interface TaskStateBaseProps

    • getTimeout

      public final Duration getTimeout()
      Description copied from interface: TaskStateBaseProps
      (deprecated) Timeout for the task.

      Default: - None

      Specified by:
      getTimeout in interface TaskStateBaseProps

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