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

Class CallApiGatewayHttpApiEndpoint.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayHttpApiEndpoint.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CallApiGatewayHttpApiEndpoint>
Enclosing class:
CallApiGatewayHttpApiEndpoint
@Stability(Stable) public static final class CallApiGatewayHttpApiEndpoint.Builder extends Object implements software.amazon.jsii.Builder<CallApiGatewayHttpApiEndpoint>
A fluent builder for CallApiGatewayHttpApiEndpoint.

  • Method Details

    • create

      @Stability(Stable) public static CallApiGatewayHttpApiEndpoint.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 CallApiGatewayHttpApiEndpoint.Builder.

    • comment

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder comment(String comment)
      A comment describing this state.

      Default: No comment

      Parameters:
      comment - A comment describing this state. This parameter is required.
      Returns:
      this

    • queryLanguage

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder queryLanguage(QueryLanguage 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-level queryLanguage field.

      Default: - JSONPath

      Parameters:
      queryLanguage - The name of the query language used by the state. This parameter is required.
      Returns:
      this

    • stateName

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder stateName(String 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

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder credentials(Credentials 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

      @Stability(Deprecated) @Deprecated public CallApiGatewayHttpApiEndpoint.Builder heartbeat(Duration heartbeat)
      Deprecated.
      use heartbeatTimeout
      (deprecated) Timeout for the heartbeat.

      Default: - None

      Parameters:
      heartbeat - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • heartbeatTimeout

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder heartbeatTimeout(Timeout 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 CallApiGatewayHttpApiEndpoint.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

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder taskTimeout(Timeout 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

      @Stability(Deprecated) @Deprecated public CallApiGatewayHttpApiEndpoint.Builder timeout(Duration timeout)
      Deprecated.
      use taskTimeout
      (deprecated) Timeout for the task.

      Default: - None

      Parameters:
      timeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • assign

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder assign(Map<String,? extends Object> 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

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder inputPath(String 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

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder outputPath(String 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

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder outputs(Object 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

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder resultPath(String 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 CallApiGatewayHttpApiEndpoint.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:

    • method

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder method(HttpMethod method)
      Http method for the API.

      Parameters:
      method - Http method for the API. This parameter is required.
      Returns:
      this

    • apiPath

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder apiPath(String apiPath)
      Path parameters appended after API endpoint.

      Default: - No path

      Parameters:
      apiPath - Path parameters appended after API endpoint. This parameter is required.
      Returns:
      this

    • authType

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder authType(AuthType authType)
      Authentication methods.

      Default: AuthType.NO_AUTH

      Parameters:
      authType - Authentication methods. This parameter is required.
      Returns:
      this

    • headers

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder headers(TaskInput headers)
      HTTP request information that does not relate to contents of the request.

      Default: - No headers

      Parameters:
      headers - HTTP request information that does not relate to contents of the request. This parameter is required.
      Returns:
      this

    • queryParameters

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder queryParameters(TaskInput queryParameters)
      Query strings attatched to end of request.

      Default: - No query parameters

      Parameters:
      queryParameters - Query strings attatched to end of request. This parameter is required.
      Returns:
      this

    • requestBody

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder requestBody(TaskInput requestBody)
      HTTP Request body.

      Default: - No request body

      Parameters:
      requestBody - HTTP Request body. This parameter is required.
      Returns:
      this

    • apiId

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder apiId(String apiId)
      The Id of the API to call.

      Parameters:
      apiId - The Id of the API to call. This parameter is required.
      Returns:
      this

    • apiStack

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder apiStack(Stack apiStack)
      The Stack in which the API is defined.

      Parameters:
      apiStack - The Stack in which the API is defined. This parameter is required.
      Returns:
      this

    • stageName

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder stageName(String stageName)
      Name of the stage where the API is deployed to in API Gateway.

      Default: '$default'

      Parameters:
      stageName - Name of the stage where the API is deployed to in API Gateway. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CallApiGatewayHttpApiEndpoint build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CallApiGatewayHttpApiEndpoint>
      Returns:
      a newly built instance of CallApiGatewayHttpApiEndpoint.