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

Class CallAwsService.Builder

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

  • Method Details

    • create

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

    • comment

      @Stability(Stable) public CallAwsService.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 CallAwsService.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 CallAwsService.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 CallAwsService.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 CallAwsService.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 CallAwsService.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 CallAwsService.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 CallAwsService.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 CallAwsService.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 CallAwsService.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 CallAwsService.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 CallAwsService.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 CallAwsService.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 CallAwsService.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 CallAwsService.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:

    • action

      @Stability(Stable) public CallAwsService.Builder action(String action)
      The API action to call.

      Use camelCase.

      Parameters:
      action - The API action to call. This parameter is required.
      Returns:
      this

    • iamResources

      @Stability(Stable) public CallAwsService.Builder iamResources(List<String> iamResources)
      The resources for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call.

      By default the action for this IAM statement will be service:action.

      Parameters:
      iamResources - The resources for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call. This parameter is required.
      Returns:
      this

    • service

      @Stability(Stable) public CallAwsService.Builder service(String service)
      The AWS service to call.

      Parameters:
      service - The AWS service to call. This parameter is required.
      Returns:
      this
      See Also:

    • additionalIamStatements

      @Stability(Stable) public CallAwsService.Builder additionalIamStatements(List<? extends PolicyStatement> additionalIamStatements)
      Additional IAM statements that will be added to the state machine role's policy.

      Use in the case where the call requires more than a single statement to be executed, e.g. rekognition:detectLabels requires also S3 permissions to read the object on which it must act.

      Default: - no additional statements are added

      Parameters:
      additionalIamStatements - Additional IAM statements that will be added to the state machine role's policy. This parameter is required.
      Returns:
      this

    • iamAction

      @Stability(Stable) public CallAwsService.Builder iamAction(String iamAction)
      The action for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call.

      Use in the case where the IAM action name does not match with the API service/action name, e.g. s3:ListBuckets requires s3:ListAllMyBuckets.

      Default: - service:action

      Parameters:
      iamAction - The action for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call. This parameter is required.
      Returns:
      this

    • parameters

      @Stability(Stable) public CallAwsService.Builder parameters(Map<String,? extends Object> parameters)
      Parameters for the API action call.

      Use PascalCase for the parameter names.

      Default: - no parameters

      Parameters:
      parameters - Parameters for the API action call. This parameter is required.
      Returns:
      this

    • build

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