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

Class CallAwsServiceCrossRegion.Builder

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

  • Method Details

    • create

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

    • comment

      @Stability(Stable) public CallAwsServiceCrossRegion.Builder comment(String comment)
      An optional description for this state.

      Default: - No comment

      Parameters:
      comment - An optional description for this state. This parameter is required.
      Returns:
      this

    • credentials

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

    • inputPath

      @Stability(Stable) public CallAwsServiceCrossRegion.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: - The entire task input (JSON path '$')

      Parameters:
      inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
      Returns:
      this

    • integrationPattern

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

    • outputPath

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

      Parameters:
      outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.
      Returns:
      this

    • resultPath

      @Stability(Stable) public CallAwsServiceCrossRegion.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: - Replaces the entire input with the result (JSON path '$')

      Parameters:
      resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.
      Returns:
      this

    • resultSelector

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

    • stateName

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

    • taskTimeout

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

    • action

      @Stability(Stable) public CallAwsServiceCrossRegion.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 CallAwsServiceCrossRegion.Builder iamResources(List<String> iamResources)
      The resources for the IAM statement that will be added to the Lambda function role's policy to allow the state machine to make the API call.

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

    • region

      @Stability(Stable) public CallAwsServiceCrossRegion.Builder region(String region)
      The AWS region to call this AWS API for.

      Example: 

       "us-east-1";

      Parameters:
      region - The AWS region to call this AWS API for. This parameter is required.
      Returns:
      this

    • service

      @Stability(Stable) public CallAwsServiceCrossRegion.Builder service(String service)
      The AWS service to call in AWS SDK for JavaScript v3 format.

      Example: 

       "s3";

      Parameters:
      service - The AWS service to call in AWS SDK for JavaScript v3 format. This parameter is required.
      Returns:
      this
      See Also:

    • additionalIamStatements

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

    • endpoint

      @Stability(Stable) public CallAwsServiceCrossRegion.Builder endpoint(String endpoint)
      The AWS API endpoint.

      Default: Do not override API endpoint.

      Parameters:
      endpoint - The AWS API endpoint. This parameter is required.
      Returns:
      this

    • iamAction

      @Stability(Stable) public CallAwsServiceCrossRegion.Builder iamAction(String iamAction)
      The action for the IAM statement that will be added to the Lambda function 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.

      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 Lambda function role's policy to allow the state machine to make the API call. This parameter is required.
      Returns:
      this

    • parameters

      @Stability(Stable) public CallAwsServiceCrossRegion.Builder parameters(Map<String,? extends Object> parameters)
      Parameters for the API action call in AWS SDK for JavaScript v3 format.

      Default: - no parameters

      Parameters:
      parameters - Parameters for the API action call in AWS SDK for JavaScript v3 format. This parameter is required.
      Returns:
      this

    • retryOnServiceExceptions

      @Stability(Stable) public CallAwsServiceCrossRegion.Builder retryOnServiceExceptions(Boolean retryOnServiceExceptions)
      Whether to retry on the backend Lambda service exceptions.

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

      Default: true

      Parameters:
      retryOnServiceExceptions - Whether to retry on the backend Lambda service exceptions. This parameter is required.
      Returns:
      this
      See Also:

    • build

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