Class: AWSCDK::StepFunctions::DistributedMap

Inherits:
MapBase
  • Object
show all
Includes:
INextable
Defined in:
step_functions/distributed_map.rb

Overview

Define a Distributed Mode Map state in the state machine.

A Map state can be used to run a set of steps for each element of an input array. A Map state will execute the same steps for multiple entries of an array in the state input.

While the Parallel state executes multiple branches of steps using the same input, a Map state will execute the same steps for multiple entries of an array in the state input.

A Map state in Distributed mode will execute a child workflow for each iteration of the Map state. This serves to increase concurrency and allows for larger workloads to be run in a single state machine.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ DistributedMap

Returns a new instance of DistributedMap.

Parameters:



23
24
25
26
27
28
29
 
# File 'step_functions/distributed_map.rb', line 23

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::StepFunctions::DistributedMapProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5EaXN0cmlidXRlZE1hcFByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.is_distributed_map(x) ⇒ Boolean

Return whether the given object is a DistributedMap.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


93
94
95
96
 
# File 'step_functions/distributed_map.rb', line 93

def self.is_distributed_map(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.DistributedMap", "isDistributedMap", [x])
end

.jsii_overridable_methods ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'step_functions/distributed_map.rb', line 31

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :branches => { kind: :property, name: "branches", is_optional: false },
    :end_states => { kind: :property, name: "endStates", is_optional: false },
    :id => { kind: :property, name: "id", is_optional: false },
    :start_state => { kind: :property, name: "startState", is_optional: false },
    :state_id => { kind: :property, name: "stateId", is_optional: false },
    :arguments => { kind: :property, name: "arguments", is_optional: true },
    :assign => { kind: :property, name: "assign", is_optional: true },
    :comment => { kind: :property, name: "comment", is_optional: true },
    :input_path => { kind: :property, name: "inputPath", is_optional: true },
    :output_path => { kind: :property, name: "outputPath", is_optional: true },
    :outputs => { kind: :property, name: "outputs", is_optional: true },
    :parameters => { kind: :property, name: "parameters", is_optional: true },
    :query_language => { kind: :property, name: "queryLanguage", is_optional: true },
    :result_path => { kind: :property, name: "resultPath", is_optional: true },
    :result_selector => { kind: :property, name: "resultSelector", is_optional: true },
    :state_name => { kind: :property, name: "stateName", is_optional: true },
    :default_choice => { kind: :property, name: "defaultChoice", is_optional: true },
    :iteration => { kind: :property, name: "iteration", is_optional: true },
    :processor => { kind: :property, name: "processor", is_optional: true },
    :processor_config => { kind: :property, name: "processorConfig", is_optional: true },
    :processor_mode => { kind: :property, name: "processorMode", is_optional: true },
    :items => { kind: :property, name: "items", is_optional: true },
    :item_selector => { kind: :property, name: "itemSelector", is_optional: true },
    :items_path => { kind: :property, name: "itemsPath", is_optional: true },
    :jsonata_item_selector => { kind: :property, name: "jsonataItemSelector", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :add_branch => { kind: :method, name: "addBranch", is_optional: false },
    :add_choice => { kind: :method, name: "addChoice", is_optional: false },
    :add_item_processor => { kind: :method, name: "addItemProcessor", is_optional: false },
    :add_iterator => { kind: :method, name: "addIterator", is_optional: false },
    :add_prefix => { kind: :method, name: "addPrefix", is_optional: false },
    :bind_to_graph => { kind: :method, name: "bindToGraph", is_optional: false },
    :make_default => { kind: :method, name: "makeDefault", is_optional: false },
    :make_next => { kind: :method, name: "makeNext", is_optional: false },
    :render_assign => { kind: :method, name: "renderAssign", is_optional: false },
    :render_branches => { kind: :method, name: "renderBranches", is_optional: false },
    :render_choices => { kind: :method, name: "renderChoices", is_optional: false },
    :render_input_output => { kind: :method, name: "renderInputOutput", is_optional: false },
    :render_item_processor => { kind: :method, name: "renderItemProcessor", is_optional: false },
    :render_iterator => { kind: :method, name: "renderIterator", is_optional: false },
    :render_next_end => { kind: :method, name: "renderNextEnd", is_optional: false },
    :render_query_language => { kind: :method, name: "renderQueryLanguage", is_optional: false },
    :render_result_selector => { kind: :method, name: "renderResultSelector", is_optional: false },
    :render_retry_catch => { kind: :method, name: "renderRetryCatch", is_optional: false },
    :to_state_json => { kind: :method, name: "toStateJson", is_optional: false },
    :validate_state => { kind: :method, name: "validateState", is_optional: false },
    :when_bound_to_graph => { kind: :method, name: "whenBoundToGraph", is_optional: false },
    :_next => { kind: :method, name: "next", is_optional: false },
    :add_catch => { kind: :method, name: "addCatch", is_optional: false },
    :add_retry => { kind: :method, name: "addRetry", is_optional: false },
    :item_processor => { kind: :method, name: "itemProcessor", is_optional: false },
  }
end

.json_path(scope, id, props = nil) ⇒ AWSCDK::StepFunctions::DistributedMap

Define a Distributed Mode Map state using JSONPath in the state machine.

A Map state can be used to run a set of steps for each element of an input array. A Map state will execute the same steps for multiple entries of an array in the state input.

While the Parallel state executes multiple branches of steps using the same input, a Map state will execute the same steps for multiple entries of an array in the state input.

A Map state in Distributed mode will execute a child workflow for each iteration of the Map state. This serves to increase concurrency and allows for larger workloads to be run in a single state machine.

Parameters:

Returns:

  • (AWSCDK::StepFunctions::DistributedMap)

See Also:



138
139
140
141
142
143
144
 
# File 'step_functions/distributed_map.rb', line 138

def self.json_path(scope, id, props = nil)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::StepFunctions::DistributedMapJsonPathProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5EaXN0cmlidXRlZE1hcEpzb25QYXRoUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.DistributedMap", "jsonPath", [scope, id, props])
end

.jsonata(scope, id, props = nil) ⇒ AWSCDK::StepFunctions::DistributedMap

Define a Distributed Mode Map state using JSONata in the state machine.

A Map state can be used to run a set of steps for each element of an input array. A Map state will execute the same steps for multiple entries of an array in the state input.

While the Parallel state executes multiple branches of steps using the same input, a Map state will execute the same steps for multiple entries of an array in the state input.

A Map state in Distributed mode will execute a child workflow for each iteration of the Map state. This serves to increase concurrency and allows for larger workloads to be run in a single state machine.

Parameters:

Returns:

  • (AWSCDK::StepFunctions::DistributedMap)

See Also:



114
115
116
117
118
119
120
 
# File 'step_functions/distributed_map.rb', line 114

def self.jsonata(scope, id, props = nil)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::StepFunctions::DistributedMapJsonataProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5EaXN0cmlidXRlZE1hcEpzb25hdGFQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.DistributedMap", "jsonata", [scope, id, props])
end

Instance Method Details

#_next(_next) ⇒ AWSCDK::StepFunctions::Chain

Continue normal execution with the given state.

Parameters:

Returns:



527
528
529
530
 
# File 'step_functions/distributed_map.rb', line 527

def _next(_next)
  Jsii::Type.check_type(_next, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5JQ2hhaW5hYmxlIn0=")), "next")
  jsii_call_method("next", [_next])
end

#add_branch(branch) ⇒ void

This method returns an undefined value.

Add a parallel branch to this state.

Parameters:



339
340
341
342
 
# File 'step_functions/distributed_map.rb', line 339

def add_branch(branch)
  Jsii::Type.check_type(branch, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZUdyYXBoIn0=")), "branch")
  jsii_call_method("addBranch", [branch])
end

#add_catch(handler, props = nil) ⇒ AWSCDK::StepFunctions::DistributedMap

Add a recovery handler for this state.

When a particular error occurs, execution will continue at the error handler instead of failing the state machine execution.

Parameters:

Returns:

  • (AWSCDK::StepFunctions::DistributedMap) 


540
541
542
543
544
545
 
# File 'step_functions/distributed_map.rb', line 540

def add_catch(handler, props = nil)
  Jsii::Type.check_type(handler, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5JQ2hhaW5hYmxlIn0=")), "handler")
  props = props.is_a?(Hash) ? ::AWSCDK::StepFunctions::CatchProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5DYXRjaFByb3BzIn0=")), "props") unless props.nil?
  jsii_call_method("addCatch", [handler, props])
end

#add_choice(condition, _next, options = nil) ⇒ void

This method returns an undefined value.

Add a choice branch to this state.

Parameters:



350
351
352
353
354
355
356
 
# File 'step_functions/distributed_map.rb', line 350

def add_choice(condition, _next, options = nil)
  Jsii::Type.check_type(condition, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5Db25kaXRpb24ifQ==")), "condition")
  Jsii::Type.check_type(_next, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZSJ9")), "next")
  options = options.is_a?(Hash) ? ::AWSCDK::StepFunctions::ChoiceTransitionOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5DaG9pY2VUcmFuc2l0aW9uT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("addChoice", [condition, _next, options])
end

#add_item_processor(processor, config = nil) ⇒ void

This method returns an undefined value.

Add a item processor to this state.

Parameters:



363
364
365
366
367
368
 
# File 'step_functions/distributed_map.rb', line 363

def add_item_processor(processor, config = nil)
  Jsii::Type.check_type(processor, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZUdyYXBoIn0=")), "processor")
  config = config.is_a?(Hash) ? ::AWSCDK::StepFunctions::ProcessorConfig.new(**config.transform_keys(&:to_sym)) : config
  Jsii::Type.check_type(config, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5Qcm9jZXNzb3JDb25maWcifQ==")), "config") unless config.nil?
  jsii_call_method("addItemProcessor", [processor, config])
end

#add_iterator(iteration) ⇒ void

This method returns an undefined value.

Add a map iterator to this state.

Parameters:



374
375
376
377
 
# File 'step_functions/distributed_map.rb', line 374

def add_iterator(iteration)
  Jsii::Type.check_type(iteration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZUdyYXBoIn0=")), "iteration")
  jsii_call_method("addIterator", [iteration])
end

#add_prefix(x) ⇒ void

This method returns an undefined value.

Add a prefix to the stateId of this state.

Parameters:

  • x (String) 


383
384
385
386
 
# File 'step_functions/distributed_map.rb', line 383

def add_prefix(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "x")
  jsii_call_method("addPrefix", [x])
end

#add_retry(props = nil) ⇒ AWSCDK::StepFunctions::DistributedMap

Add retry configuration for this state.

This controls if and how the execution will be retried if a particular error occurs.

Parameters:

Returns:

  • (AWSCDK::StepFunctions::DistributedMap) 


554
555
556
557
558
 
# File 'step_functions/distributed_map.rb', line 554

def add_retry(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::StepFunctions::RetryProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5SZXRyeVByb3BzIn0=")), "props") unless props.nil?
  jsii_call_method("addRetry", [props])
end

#arguments ⇒ Hash?

Returns:

  • (Hash, nil) 


187
188
189
 
# File 'step_functions/distributed_map.rb', line 187

def arguments()
  jsii_get_property("arguments")
end

#assign ⇒ Hash?

Returns:

  • (Hash, nil) 


192
193
194
 
# File 'step_functions/distributed_map.rb', line 192

def assign()
  jsii_get_property("assign")
end

#bind_to_graph(graph) ⇒ void

This method returns an undefined value.

Register this state as part of the given graph.

Don't call this. It will be called automatically when you work with states normally.

Parameters:



395
396
397
398
 
# File 'step_functions/distributed_map.rb', line 395

def bind_to_graph(graph)
  Jsii::Type.check_type(graph, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZUdyYXBoIn0=")), "graph")
  jsii_call_method("bindToGraph", [graph])
end

#branches ⇒ Array<AWSCDK::StepFunctions::StateGraph>

Returns:



154
155
156
 
# File 'step_functions/distributed_map.rb', line 154

def branches()
  jsii_get_property("branches")
end

#comment ⇒ String?

Returns:

  • (String, nil) 


197
198
199
 
# File 'step_functions/distributed_map.rb', line 197

def comment()
  jsii_get_property("comment")
end

#default_choice ⇒ AWSCDK::StepFunctions::State?

Returns:



242
243
244
 
# File 'step_functions/distributed_map.rb', line 242

def default_choice()
  jsii_get_property("defaultChoice")
end

#default_choice=(value) ⇒ Object 



246
247
248
249
 
# File 'step_functions/distributed_map.rb', line 246

def default_choice=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZSJ9")), "defaultChoice") unless value.nil?
  jsii_set_property("defaultChoice", value)
end

#end_states ⇒ Array<AWSCDK::StepFunctions::INextable>

Continuable states of this Chainable.

Returns:



161
162
163
 
# File 'step_functions/distributed_map.rb', line 161

def end_states()
  jsii_get_property("endStates")
end

#id ⇒ String

Descriptive identifier for this chainable.

Returns:

  • (String) 


168
169
170
 
# File 'step_functions/distributed_map.rb', line 168

def id()
  jsii_get_property("id")
end

#input_path ⇒ String?

Returns:

  • (String, nil) 


202
203
204
 
# File 'step_functions/distributed_map.rb', line 202

def input_path()
  jsii_get_property("inputPath")
end

#item_processor(processor, config = nil) ⇒ AWSCDK::StepFunctions::DistributedMap

Define item processor in a Distributed Map.

A Distributed Map must have a non-empty item processor

Parameters:

Returns:

  • (AWSCDK::StepFunctions::DistributedMap) 


567
568
569
570
571
572
 
# File 'step_functions/distributed_map.rb', line 567

def item_processor(processor, config = nil)
  Jsii::Type.check_type(processor, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5JQ2hhaW5hYmxlIn0=")), "processor")
  config = config.is_a?(Hash) ? ::AWSCDK::StepFunctions::ProcessorConfig.new(**config.transform_keys(&:to_sym)) : config
  Jsii::Type.check_type(config, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5Qcm9jZXNzb3JDb25maWcifQ==")), "config") unless config.nil?
  jsii_call_method("itemProcessor", [processor, config])
end

#item_selector ⇒ Hash{String => Object}?

Returns:

  • (Hash{String => Object}, nil) 


298
299
300
 
# File 'step_functions/distributed_map.rb', line 298

def item_selector()
  jsii_get_property("itemSelector")
end

#items ⇒ AWSCDK::StepFunctions::ProvideItems?

Returns:



293
294
295
 
# File 'step_functions/distributed_map.rb', line 293

def items()
  jsii_get_property("items")
end

#items_path ⇒ String?

Returns:

  • (String, nil) 


303
304
305
 
# File 'step_functions/distributed_map.rb', line 303

def items_path()
  jsii_get_property("itemsPath")
end

#iteration ⇒ AWSCDK::StepFunctions::StateGraph?

Returns:



252
253
254
 
# File 'step_functions/distributed_map.rb', line 252

def iteration()
  jsii_get_property("iteration")
end

#iteration=(value) ⇒ Object 



256
257
258
259
 
# File 'step_functions/distributed_map.rb', line 256

def iteration=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZUdyYXBoIn0=")), "iteration") unless value.nil?
  jsii_set_property("iteration", value)
end

#jsonata_item_selector ⇒ String?

Returns:

  • (String, nil) 


308
309
310
 
# File 'step_functions/distributed_map.rb', line 308

def jsonata_item_selector()
  jsii_get_property("jsonataItemSelector")
end

#make_default(_def) ⇒ void

This method returns an undefined value.

Make the indicated state the default choice transition of this state.

Parameters:



404
405
406
407
 
# File 'step_functions/distributed_map.rb', line 404

def make_default(_def)
  Jsii::Type.check_type(_def, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZSJ9")), "def")
  jsii_call_method("makeDefault", [_def])
end

#make_next(_next) ⇒ void

This method returns an undefined value.

Make the indicated state the default transition of this state.

Parameters:



413
414
415
416
 
# File 'step_functions/distributed_map.rb', line 413

def make_next(_next)
  Jsii::Type.check_type(_next, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZSJ9")), "next")
  jsii_call_method("makeNext", [_next])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


149
150
151
 
# File 'step_functions/distributed_map.rb', line 149

def node()
  jsii_get_property("node")
end

#output_path ⇒ String?

Returns:

  • (String, nil) 


207
208
209
 
# File 'step_functions/distributed_map.rb', line 207

def output_path()
  jsii_get_property("outputPath")
end

#outputs ⇒ Hash?

Returns:

  • (Hash, nil) 


212
213
214
 
# File 'step_functions/distributed_map.rb', line 212

def outputs()
  jsii_get_property("outputs")
end

#parameters ⇒ Hash?

Returns:

  • (Hash, nil) 


217
218
219
 
# File 'step_functions/distributed_map.rb', line 217

def parameters()
  jsii_get_property("parameters")
end

#processor ⇒ AWSCDK::StepFunctions::StateGraph?

Returns:



262
263
264
 
# File 'step_functions/distributed_map.rb', line 262

def processor()
  jsii_get_property("processor")
end

#processor=(value) ⇒ Object 



266
267
268
269
 
# File 'step_functions/distributed_map.rb', line 266

def processor=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZUdyYXBoIn0=")), "processor") unless value.nil?
  jsii_set_property("processor", value)
end

#processor_config ⇒ AWSCDK::StepFunctions::ProcessorConfig?

Returns:



272
273
274
 
# File 'step_functions/distributed_map.rb', line 272

def processor_config()
  jsii_get_property("processorConfig")
end

#processor_config=(value) ⇒ Object 



276
277
278
279
280
 
# File 'step_functions/distributed_map.rb', line 276

def processor_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::StepFunctions::ProcessorConfig.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5Qcm9jZXNzb3JDb25maWcifQ==")), "processorConfig") unless value.nil?
  jsii_set_property("processorConfig", value)
end

#processor_mode ⇒ AWSCDK::StepFunctions::ProcessorMode?

Returns:



283
284
285
 
# File 'step_functions/distributed_map.rb', line 283

def processor_mode()
  jsii_get_property("processorMode")
end

#processor_mode=(value) ⇒ Object 



287
288
289
290
 
# File 'step_functions/distributed_map.rb', line 287

def processor_mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5Qcm9jZXNzb3JNb2RlIn0=")), "processorMode") unless value.nil?
  jsii_set_property("processorMode", value)
end

#query_language ⇒ AWSCDK::StepFunctions::QueryLanguage?

Returns:



222
223
224
 
# File 'step_functions/distributed_map.rb', line 222

def query_language()
  jsii_get_property("queryLanguage")
end

#render_assign(top_level_query_language = nil) ⇒ Object

Render the assign in ASL JSON format.

Parameters:

Returns:

  • (Object) 


422
423
424
425
 
# File 'step_functions/distributed_map.rb', line 422

def render_assign(top_level_query_language = nil)
  Jsii::Type.check_type(top_level_query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "topLevelQueryLanguage") unless top_level_query_language.nil?
  jsii_call_method("renderAssign", [top_level_query_language])
end

#render_branches ⇒ Object

Render parallel branches in ASL JSON format.

Returns:

  • (Object) 


430
431
432
 
# File 'step_functions/distributed_map.rb', line 430

def render_branches()
  jsii_call_method("renderBranches", [])
end

#render_choices(top_level_query_language = nil) ⇒ Object

Render the choices in ASL JSON format.

Parameters:

Returns:

  • (Object) 


438
439
440
441
 
# File 'step_functions/distributed_map.rb', line 438

def render_choices(top_level_query_language = nil)
  Jsii::Type.check_type(top_level_query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "topLevelQueryLanguage") unless top_level_query_language.nil?
  jsii_call_method("renderChoices", [top_level_query_language])
end

#render_input_output ⇒ Object

Render InputPath/Parameters/OutputPath/Arguments/Output in ASL JSON format.

Returns:

  • (Object) 


446
447
448
 
# File 'step_functions/distributed_map.rb', line 446

def render_input_output()
  jsii_call_method("renderInputOutput", [])
end

#render_item_processor ⇒ Object

Render ItemProcessor in ASL JSON format.

Returns:

  • (Object) 


453
454
455
 
# File 'step_functions/distributed_map.rb', line 453

def render_item_processor()
  jsii_call_method("renderItemProcessor", [])
end

#render_iterator ⇒ Object

Render map iterator in ASL JSON format.

Returns:

  • (Object) 


460
461
462
 
# File 'step_functions/distributed_map.rb', line 460

def render_iterator()
  jsii_call_method("renderIterator", [])
end

#render_next_end ⇒ Object

Render the default next state in ASL JSON format.

Returns:

  • (Object) 


467
468
469
 
# File 'step_functions/distributed_map.rb', line 467

def render_next_end()
  jsii_call_method("renderNextEnd", [])
end

#render_query_language(top_level_query_language = nil) ⇒ Object

Render QueryLanguage in ASL JSON format if needed.

Parameters:

Returns:

  • (Object) 


475
476
477
478
 
# File 'step_functions/distributed_map.rb', line 475

def render_query_language(top_level_query_language = nil)
  Jsii::Type.check_type(top_level_query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "topLevelQueryLanguage") unless top_level_query_language.nil?
  jsii_call_method("renderQueryLanguage", [top_level_query_language])
end

#render_result_selector ⇒ Object

Render ResultSelector in ASL JSON format.

Returns:

  • (Object) 


483
484
485
 
# File 'step_functions/distributed_map.rb', line 483

def render_result_selector()
  jsii_call_method("renderResultSelector", [])
end

#render_retry_catch(top_level_query_language = nil) ⇒ Object

Render error recovery options in ASL JSON format.

Parameters:

Returns:

  • (Object) 


491
492
493
494
 
# File 'step_functions/distributed_map.rb', line 491

def render_retry_catch(top_level_query_language = nil)
  Jsii::Type.check_type(top_level_query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "topLevelQueryLanguage") unless top_level_query_language.nil?
  jsii_call_method("renderRetryCatch", [top_level_query_language])
end

#result_path ⇒ String?

Returns:

  • (String, nil) 


227
228
229
 
# File 'step_functions/distributed_map.rb', line 227

def result_path()
  jsii_get_property("resultPath")
end

#result_selector ⇒ Hash?

Returns:

  • (Hash, nil) 


232
233
234
 
# File 'step_functions/distributed_map.rb', line 232

def result_selector()
  jsii_get_property("resultSelector")
end

#start_state ⇒ AWSCDK::StepFunctions::State

First state of this Chainable.

Returns:



175
176
177
 
# File 'step_functions/distributed_map.rb', line 175

def start_state()
  jsii_get_property("startState")
end

#state_id ⇒ String

Tokenized string that evaluates to the state's ID.

Returns:

  • (String) 


182
183
184
 
# File 'step_functions/distributed_map.rb', line 182

def state_id()
  jsii_get_property("stateId")
end

#state_name ⇒ String?

Returns:

  • (String, nil) 


237
238
239
 
# File 'step_functions/distributed_map.rb', line 237

def state_name()
  jsii_get_property("stateName")
end

#to_state_json(state_machine_query_language = nil) ⇒ Hash

Return the Amazon States Language object for this state.

Parameters:

Returns:

  • (Hash) 


500
501
502
503
 
# File 'step_functions/distributed_map.rb', line 500

def to_state_json(state_machine_query_language = nil)
  Jsii::Type.check_type(state_machine_query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "stateMachineQueryLanguage") unless state_machine_query_language.nil?
  jsii_call_method("toStateJson", [state_machine_query_language])
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


315
316
317
 
# File 'step_functions/distributed_map.rb', line 315

def to_string()
  jsii_call_method("toString", [])
end

#validate_state ⇒ Array<String>

Validate this state.

Returns:

  • (Array<String>) 


508
509
510
 
# File 'step_functions/distributed_map.rb', line 508

def validate_state()
  jsii_call_method("validateState", [])
end

#when_bound_to_graph(graph) ⇒ void

This method returns an undefined value.

Called whenever this state is bound to a graph.

Can be overridden by subclasses.

Parameters:



518
519
520
521
 
# File 'step_functions/distributed_map.rb', line 518

def when_bound_to_graph(graph)
  Jsii::Type.check_type(graph, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZUdyYXBoIn0=")), "graph")
  jsii_call_method("whenBoundToGraph", [graph])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



328
329
330
331
332
333
 
# File 'step_functions/distributed_map.rb', line 328

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end