software.amazon.awscdk.services.stepfunctions

Class Map.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.Map.Builder

Enclosing class:

Map

public static final class Map.Builder
extends java.lang.Object

A fluent builder for Map.

Method Summary

Modifier and Type	Method and Description
Map	build()
Map.Builder	comment(java.lang.String comment) An optional description for this state.
static Map.Builder	create(software.constructs.Construct scope, java.lang.String id)
Map.Builder	inputPath(java.lang.String inputPath) JSONPath expression to select part of the state to be the input to this state.
Map.Builder	itemsPath(java.lang.String itemsPath) JSONPath expression to select the array to iterate over.
Map.Builder	maxConcurrency(java.lang.Number maxConcurrency) MaxConcurrency.
Map.Builder	outputPath(java.lang.String outputPath) JSONPath expression to select part of the state to be the output to this state.
Map.Builder	parameters(java.util.Map<java.lang.String,? extends java.lang.Object> parameters) The JSON that you want to override your default iteration input.
Map.Builder	resultPath(java.lang.String resultPath) JSONPath expression to indicate where to inject the state's output.
Map.Builder	resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector) The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Map.Builder create(software.constructs.Construct scope,
                                 java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Map.Builder.

comment

public Map.Builder comment(java.lang.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

inputPath

public Map.Builder inputPath(java.lang.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

itemsPath

public Map.Builder itemsPath(java.lang.String itemsPath)

JSONPath expression to select the array to iterate over.

Default: $

Parameters:

itemsPath - JSONPath expression to select the array to iterate over. This parameter is required.

Returns:

this

maxConcurrency

public Map.Builder maxConcurrency(java.lang.Number maxConcurrency)

MaxConcurrency.

An upper bound on the number of iterations you want running at once.

Default: - full concurrency

Parameters:

maxConcurrency - MaxConcurrency. This parameter is required.

Returns:

this

outputPath

public Map.Builder outputPath(java.lang.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

parameters

public Map.Builder parameters(java.util.Map<java.lang.String,? extends java.lang.Object> parameters)

The JSON that you want to override your default iteration input.

Default: $

Parameters:

parameters - The JSON that you want to override your default iteration input. This parameter is required.

Returns:

this

resultPath

public Map.Builder resultPath(java.lang.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

public Map.Builder resultSelector(java.util.Map<java.lang.String,? extends java.lang.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

build

public Map build()