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

Class LambdaInvokeProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.stepfunctions.tasks.LambdaInvokeProps.Jsii$Proxy
All Implemented Interfaces:
LambdaInvokeProps, TaskStateBaseProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
LambdaInvokeProps
@Stability(Stable) @Internal public static final class LambdaInvokeProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements LambdaInvokeProps
An implementation for LambdaInvokeProps

  • 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(LambdaInvokeProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the LambdaInvokeProps.Builder.

  • Method Details

    • getLambdaFunction

      public final IFunction getLambdaFunction()
      Description copied from interface: LambdaInvokeProps
      Lambda function to invoke.
      Specified by:
      getLambdaFunction in interface LambdaInvokeProps

    • getClientContext

      public final String getClientContext()
      Description copied from interface: LambdaInvokeProps
      Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.

      Default: - No context

      Specified by:
      getClientContext in interface LambdaInvokeProps

    • getInvocationType

      public final LambdaInvocationType getInvocationType()
      Description copied from interface: LambdaInvokeProps
      Invocation type of the Lambda function.

      Default: InvocationType.REQUEST_RESPONSE

      Specified by:
      getInvocationType in interface LambdaInvokeProps

    • getPayload

      public final TaskInput getPayload()
      Description copied from interface: LambdaInvokeProps
      The JSON that will be supplied as input to the Lambda function.

      Default: - The state input (JSON path '$')

      Specified by:
      getPayload in interface LambdaInvokeProps

    • getPayloadResponseOnly

      public final Boolean getPayloadResponseOnly()
      Description copied from interface: LambdaInvokeProps
      Invoke the Lambda in a way that only returns the payload response without additional metadata.

      The payloadResponseOnly property cannot be used if integrationPattern, invocationType, clientContext, or qualifier are specified. It always uses the REQUEST_RESPONSE behavior.

      Default: false

      Specified by:
      getPayloadResponseOnly in interface LambdaInvokeProps

    • getQualifier

      public final String getQualifier()
      Description copied from interface: LambdaInvokeProps
      (deprecated) Version or alias to invoke a published version of the function.

      You only need to supply this if you want the version of the Lambda Function to depend on data in the state machine state. If not, you can pass the appropriate Alias or Version object directly as the lambdaFunction argument.

      Default: - Version or alias inherent to the `lambdaFunction` object.

      Specified by:
      getQualifier in interface LambdaInvokeProps

    • getRetryOnServiceExceptions

      public final Boolean getRetryOnServiceExceptions()
      Description copied from interface: LambdaInvokeProps
      Whether to retry on Lambda service exceptions.

      This handles Lambda.ServiceException, Lambda.AWSLambdaException and Lambda.SdkClientException with an interval of 2 seconds, a back-off rate of 2 and 6 maximum attempts.

      Default: true

      Specified by:
      getRetryOnServiceExceptions in interface LambdaInvokeProps
      See Also:

    • 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

    • getHeartbeat

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

      Default: - None

      Specified by:
      getHeartbeat 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

      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:

    • getTimeout

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

      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