Package software.amazon.awscdk.services.stepfunctions

Class DistributedMapProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.DistributedMapProps.Jsii$Proxy

All Implemented Interfaces:

AssignableStateOptions, DistributedMapProps, JsonataCommonOptions, JsonPathCommonOptions, MapBaseJsonataOptions, MapBaseJsonPathOptions, MapBaseOptions, MapBaseProps, StateBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

DistributedMapProps

@Stability(Stable)
@Internal
public static final class DistributedMapProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements DistributedMapProps

An implementation for DistributedMapProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.DistributedMapProps

DistributedMapProps.Builder, DistributedMapProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(DistributedMapProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the DistributedMapProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Map<String,Object>	getAssign()	Workflow variables to store in this step.
final String	getComment()	A comment describing this state.
final String	getInputPath()	JSONPath expression to select part of the state to be the input to this state.
final ItemBatcher	getItemBatcher()	Specifies to process a group of items in a single child workflow execution.
final IItemReader	getItemReader()	ItemReader.
final ProvideItems	getItems()	The array that the Map state will iterate over.
final Map<String,Object>	getItemSelector()	The JSON that you want to override your default iteration input (mutually exclusive with parameters and jsonataItemSelector).
final String	getItemsPath()	JSONPath expression to select the array to iterate over.
final String	getJsonataItemSelector()	Jsonata expression that evaluates to a JSON array to override your default iteration input (mutually exclusive with parameters and itemSelector).
final String	getLabel()	Label.
final StateMachineType	getMapExecutionType()	MapExecutionType.
final Number	getMaxConcurrency()	MaxConcurrency.
final String	getMaxConcurrencyPath()	MaxConcurrencyPath.
final String	getOutputPath()	JSONPath expression to select part of the state to be the output to this state.
final Object	getOutputs()	Used to specify and transform output from the state.
final QueryLanguage	getQueryLanguage()	The name of the query language used by the state.
final String	getResultPath()	JSONPath expression to indicate where to inject the state's output.
final Map<String,Object>	getResultSelector()	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
final ResultWriter	getResultWriter()	(deprecated) Configuration for S3 location in which to save Map Run results.
final ResultWriterV2	getResultWriterV2()	Configuration for S3 location in which to save Map Run results Enable "@aws-cdk/aws-stepfunctions:useDistributedMapResultWriterV2" feature in the context to use resultWriterV2 Example: stack.node.setContext("@aws-cdk/aws-stepfunctions:useDistributedMapResultWriterV2", true);
final String	getStateName()	Optional name for this state.
final Number	getToleratedFailureCount()	ToleratedFailureCount.
final String	getToleratedFailureCountPath()	ToleratedFailureCountPath.
final Number	getToleratedFailurePercentage()	ToleratedFailurePercentage.
final String	getToleratedFailurePercentagePath()	ToleratedFailurePercentagePath.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(DistributedMapProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the DistributedMapProps.Builder.

Method Details

getItemBatcher

public final ItemBatcher getItemBatcher()

Description copied from interface: DistributedMapProps

Specifies to process a group of items in a single child workflow execution.

Default: - No itemBatcher

Specified by:

getItemBatcher in interface DistributedMapProps

getItemReader

public final IItemReader getItemReader()

Description copied from interface: DistributedMapProps

ItemReader.

Configuration for where to read items dataset in S3 to iterate

Default: - No itemReader

Specified by:

getItemReader in interface DistributedMapProps

getLabel

public final String getLabel()

Description copied from interface: DistributedMapProps

Label.

Unique name for the Distributed Map state added to each Map Run

Default: - No label

Specified by:

getLabel in interface DistributedMapProps

getMapExecutionType

public final StateMachineType getMapExecutionType()

Description copied from interface: DistributedMapProps

MapExecutionType.

The execution type of the distributed map state

This property overwrites ProcessorConfig.executionType

Default: StateMachineType.STANDARD

Specified by:

getMapExecutionType in interface DistributedMapProps

getResultWriter

public final ResultWriter getResultWriter()

Description copied from interface: DistributedMapProps

(deprecated) Configuration for S3 location in which to save Map Run results.

Default: - No resultWriter

Specified by:

getResultWriter in interface DistributedMapProps

getResultWriterV2

public final ResultWriterV2 getResultWriterV2()

Description copied from interface: DistributedMapProps

Configuration for S3 location in which to save Map Run results Enable "@aws-cdk/aws-stepfunctions:useDistributedMapResultWriterV2" feature in the context to use resultWriterV2 Example: stack.node.setContext("@aws-cdk/aws-stepfunctions:useDistributedMapResultWriterV2", true);

Default: - No resultWriterV2

Specified by:

getResultWriterV2 in interface DistributedMapProps

getToleratedFailureCount

public final Number getToleratedFailureCount()

Description copied from interface: DistributedMapProps

ToleratedFailureCount.

Number of failed items to tolerate in a Map Run, as static number

Default: - No toleratedFailureCount

Specified by:

getToleratedFailureCount in interface DistributedMapProps

getToleratedFailureCountPath

public final String getToleratedFailureCountPath()

Description copied from interface: DistributedMapProps

ToleratedFailureCountPath.

Number of failed items to tolerate in a Map Run, as JsonPath

Default: - No toleratedFailureCountPath

Specified by:

getToleratedFailureCountPath in interface DistributedMapProps

getToleratedFailurePercentage

public final Number getToleratedFailurePercentage()

Description copied from interface: DistributedMapProps

ToleratedFailurePercentage.

Percentage of failed items to tolerate in a Map Run, as static number

Default: - No toleratedFailurePercentage

Specified by:

getToleratedFailurePercentage in interface DistributedMapProps

getToleratedFailurePercentagePath

public final String getToleratedFailurePercentagePath()

Description copied from interface: DistributedMapProps

ToleratedFailurePercentagePath.

Percentage of failed items to tolerate in a Map Run, as JsonPath

Default: - No toleratedFailurePercentagePath

Specified by:

getToleratedFailurePercentagePath in interface DistributedMapProps

getComment

public final String getComment()

Description copied from interface: StateBaseProps

A comment describing this state.

Default: No comment

Specified by:

getComment in interface StateBaseProps

getQueryLanguage

public final QueryLanguage getQueryLanguage()

Description copied from interface: StateBaseProps

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

Specified by:

getQueryLanguage in interface StateBaseProps

getStateName

public final String getStateName()

Description copied from interface: StateBaseProps

Optional name for this state.

Default: - The construct ID will be used as state name

Specified by:

getStateName in interface StateBaseProps

getItemSelector

public final Map<String,Object> getItemSelector()

Description copied from interface: DistributedMapProps

The JSON that you want to override your default iteration input (mutually exclusive with parameters and jsonataItemSelector).

Default: $

Specified by:

getItemSelector in interface DistributedMapProps

Specified by:

getItemSelector in interface MapBaseOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-itemselector.html

getJsonataItemSelector

public final String getJsonataItemSelector()

Description copied from interface: DistributedMapProps

Jsonata expression that evaluates to a JSON array to override your default iteration input (mutually exclusive with parameters and itemSelector).

Example value: {% {\"foo\": \"foo\", \"input\": $states.input} %}

Default: $

Specified by:

getJsonataItemSelector in interface DistributedMapProps

Specified by:

getJsonataItemSelector in interface MapBaseOptions

getMaxConcurrency

public final Number getMaxConcurrency()

Description copied from interface: DistributedMapProps

MaxConcurrency.

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

Default: - full concurrency

Specified by:

getMaxConcurrency in interface DistributedMapProps

Specified by:

getMaxConcurrency in interface MapBaseOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-asl-use-map-state-inline.html#map-state-inline-additional-fields

getAssign

public final Map<String,Object> getAssign()

Description copied from interface: DistributedMapProps

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

Specified by:

getAssign in interface AssignableStateOptions

Specified by:

getAssign in interface DistributedMapProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

getItemsPath

public final String getItemsPath()

Description copied from interface: DistributedMapProps

JSONPath expression to select the array to iterate over.

Default: $

Specified by:

getItemsPath in interface DistributedMapProps

Specified by:

getItemsPath in interface MapBaseJsonPathOptions

getMaxConcurrencyPath

public final String getMaxConcurrencyPath()

Description copied from interface: DistributedMapProps

MaxConcurrencyPath.

A JsonPath that specifies the maximum concurrency dynamically from the state input.

Default: - full concurrency

Specified by:

getMaxConcurrencyPath in interface DistributedMapProps

Specified by:

getMaxConcurrencyPath in interface MapBaseJsonPathOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-asl-use-map-state-inline.html#map-state-inline-additional-fields

getResultPath

public final String getResultPath()

Description copied from interface: DistributedMapProps

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: $

Specified by:

getResultPath in interface DistributedMapProps

Specified by:

getResultPath in interface MapBaseJsonPathOptions

getResultSelector

public final Map<String,Object> getResultSelector()

Description copied from interface: DistributedMapProps

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

Specified by:

getResultSelector in interface DistributedMapProps

Specified by:

getResultSelector in interface MapBaseJsonPathOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

getInputPath

public final String getInputPath()

Description copied from interface: DistributedMapProps

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: $

Specified by:

getInputPath in interface DistributedMapProps

Specified by:

getInputPath in interface JsonPathCommonOptions

getOutputPath

public final String getOutputPath()

Description copied from interface: DistributedMapProps

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: $

Specified by:

getOutputPath in interface DistributedMapProps

Specified by:

getOutputPath in interface JsonPathCommonOptions

getItems

public final ProvideItems getItems()

Description copied from interface: DistributedMapProps

The array that the Map state will iterate over.

Default: - The state input as is.

Specified by:

getItems in interface DistributedMapProps

Specified by:

getItems in interface MapBaseJsonataOptions

getOutputs

public final Object getOutputs()

Description copied from interface: DistributedMapProps

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

Specified by:

getOutputs in interface DistributedMapProps

Specified by:

getOutputs in interface JsonataCommonOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object