CallAwsService.Builder (software.amazon.awscdk:stepfunctions-tasks 1.185.0 API)

java.lang.Object
- software.amazon.awscdk.services.stepfunctions.tasks.CallAwsService.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CallAwsService>

Enclosing class:: CallAwsService

@Stability(value=Stable)
public static final class CallAwsService.Builder
extends Object
implements software.amazon.jsii.Builder<CallAwsService>

A fluent builder for CallAwsService.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CallAwsService.Builder`	`action(String action)` The API action to call.
`CallAwsService`	`build()`
`CallAwsService.Builder`	`comment(String comment)` An optional description for this state.
`static CallAwsService.Builder`	`create(software.constructs.Construct scope, String id)`
`CallAwsService.Builder`	`heartbeat(Duration heartbeat)` Timeout for the heartbeat.
`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.
`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.
`CallAwsService.Builder`	`inputPath(String inputPath)` JSONPath expression to select part of the state to be the input to this state.
`CallAwsService.Builder`	`integrationPattern(IntegrationPattern integrationPattern)` AWS Step Functions integrates with services directly in the Amazon States Language.
`CallAwsService.Builder`	`outputPath(String outputPath)` JSONPath expression to select select a portion of the state output to pass to the next state.
`CallAwsService.Builder`	`parameters(Map<String,? extends Object> parameters)` Parameters for the API action call.
`CallAwsService.Builder`	`resultPath(String resultPath)` JSONPath expression to indicate where to inject the state's output.
`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.
`CallAwsService.Builder`	`service(String service)` The AWS service to call.
`CallAwsService.Builder`	`timeout(Duration timeout)` Timeout for the state machine.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
@Stability(value=Stable)
public static CallAwsService.Builder create(software.constructs.Construct scope,
                                                                     String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of CallAwsService.Builder.
  - comment
```
@Stability(value=Stable)
public CallAwsService.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
  - heartbeat
```
@Stability(value=Stable)
public CallAwsService.Builder heartbeat(Duration heartbeat)
```
    Timeout for the heartbeat.
    Default: - None
    
    Parameters:
    
    heartbeat - Timeout for the heartbeat. This parameter is required.
    
    Returns:
    
    this
  - inputPath
```
@Stability(value=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: - 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(value=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
    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:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
  - outputPath
```
@Stability(value=Stable)
public CallAwsService.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(value=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: - 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(value=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:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector
  - timeout
```
@Stability(value=Stable)
public CallAwsService.Builder timeout(Duration timeout)
```
    Timeout for the state machine.
    Default: - None
    
    Parameters:
    
    timeout - Timeout for the state machine. This parameter is required.
    
    Returns:
    
    this
  - action
```
@Stability(value=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(value=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(value=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:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/supported-services-awssdk.html
  - iamAction
```
@Stability(value=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(value=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(value=Stable)
public CallAwsService build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CallAwsService>

Class CallAwsService.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

comment

heartbeat

inputPath

integrationPattern

outputPath

resultPath

resultSelector

timeout

action

iamResources

service

iamAction

parameters

build