Class: AWSCDK::StepFunctions::Map

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

Overview

Define a 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.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Map.

Parameters:



20
21
22
23
24
25
26
 
# File 'step_functions/map.rb', line 20

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::StepFunctions::MapProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5NYXBQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



28
29
30
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
 
# File 'step_functions/map.rb', line 28

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 },
    :iterator => { kind: :method, name: "iterator", is_optional: false },
  }
end

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

Define a 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.

Parameters:

Returns:

  • (AWSCDK::StepFunctions::Map)

See Also:



121
122
123
124
125
126
127
 
# File 'step_functions/map.rb', line 121

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::MapJsonPathProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5NYXBKc29uUGF0aFByb3BzIn0=")), "props") unless props.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.Map", "jsonPath", [scope, id, props])
end

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

Define a 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.

Parameters:

Returns:

  • (AWSCDK::StepFunctions::Map)

See Also:



100
101
102
103
104
105
106
 
# File 'step_functions/map.rb', line 100

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::MapJsonataProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5NYXBKc29uYXRhUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.Map", "jsonata", [scope, id, props])
end

Instance Method Details

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

Continue normal execution with the given state.

Parameters:

Returns:



510
511
512
513
 
# File 'step_functions/map.rb', line 510

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:



322
323
324
325
 
# File 'step_functions/map.rb', line 322

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

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::Map) 


523
524
525
526
527
528
 
# File 'step_functions/map.rb', line 523

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:



333
334
335
336
337
338
339
 
# File 'step_functions/map.rb', line 333

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:



346
347
348
349
350
351
 
# File 'step_functions/map.rb', line 346

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:



357
358
359
360
 
# File 'step_functions/map.rb', line 357

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) 


366
367
368
369
 
# File 'step_functions/map.rb', line 366

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

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::Map) 


537
538
539
540
541
 
# File 'step_functions/map.rb', line 537

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) 


170
171
172
 
# File 'step_functions/map.rb', line 170

def arguments()
  jsii_get_property("arguments")
end

#assign ⇒ Hash?

Returns:

  • (Hash, nil) 


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

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:



378
379
380
381
 
# File 'step_functions/map.rb', line 378

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:



137
138
139
 
# File 'step_functions/map.rb', line 137

def branches()
  jsii_get_property("branches")
end

#comment ⇒ String?

Returns:

  • (String, nil) 


180
181
182
 
# File 'step_functions/map.rb', line 180

def comment()
  jsii_get_property("comment")
end

#default_choice ⇒ AWSCDK::StepFunctions::State?

Returns:



225
226
227
 
# File 'step_functions/map.rb', line 225

def default_choice()
  jsii_get_property("defaultChoice")
end

#default_choice=(value) ⇒ Object 



229
230
231
232
 
# File 'step_functions/map.rb', line 229

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:



144
145
146
 
# File 'step_functions/map.rb', line 144

def end_states()
  jsii_get_property("endStates")
end

#id ⇒ String

Descriptive identifier for this chainable.

Returns:

  • (String) 


151
152
153
 
# File 'step_functions/map.rb', line 151

def id()
  jsii_get_property("id")
end

#input_path ⇒ String?

Returns:

  • (String, nil) 


185
186
187
 
# File 'step_functions/map.rb', line 185

def input_path()
  jsii_get_property("inputPath")
end

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

Define item processor in Map.

A Map must either have a non-empty iterator or a non-empty item processor (mutually exclusive with iterator).

Parameters:

Returns:

  • (AWSCDK::StepFunctions::Map) 


550
551
552
553
554
555
 
# File 'step_functions/map.rb', line 550

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) 


281
282
283
 
# File 'step_functions/map.rb', line 281

def item_selector()
  jsii_get_property("itemSelector")
end

#items ⇒ AWSCDK::StepFunctions::ProvideItems?

Returns:



276
277
278
 
# File 'step_functions/map.rb', line 276

def items()
  jsii_get_property("items")
end

#items_path ⇒ String?

Returns:

  • (String, nil) 


286
287
288
 
# File 'step_functions/map.rb', line 286

def items_path()
  jsii_get_property("itemsPath")
end

#iteration ⇒ AWSCDK::StepFunctions::StateGraph?

Returns:



235
236
237
 
# File 'step_functions/map.rb', line 235

def iteration()
  jsii_get_property("iteration")
end

#iteration=(value) ⇒ Object 



239
240
241
242
 
# File 'step_functions/map.rb', line 239

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

#iterator(iterator) ⇒ AWSCDK::StepFunctions::Map

Deprecated.
  • use itemProcessor instead.

Define iterator state machine in Map.

A Map must either have a non-empty iterator or a non-empty item processor (mutually exclusive with item_processor).

Parameters:

Returns:

  • (AWSCDK::StepFunctions::Map) 


564
565
566
567
 
# File 'step_functions/map.rb', line 564

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

#jsonata_item_selector ⇒ String?

Returns:

  • (String, nil) 


291
292
293
 
# File 'step_functions/map.rb', line 291

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:



387
388
389
390
 
# File 'step_functions/map.rb', line 387

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:



396
397
398
399
 
# File 'step_functions/map.rb', line 396

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) 


132
133
134
 
# File 'step_functions/map.rb', line 132

def node()
  jsii_get_property("node")
end

#output_path ⇒ String?

Returns:

  • (String, nil) 


190
191
192
 
# File 'step_functions/map.rb', line 190

def output_path()
  jsii_get_property("outputPath")
end

#outputs ⇒ Hash?

Returns:

  • (Hash, nil) 


195
196
197
 
# File 'step_functions/map.rb', line 195

def outputs()
  jsii_get_property("outputs")
end

#parameters ⇒ Hash?

Returns:

  • (Hash, nil) 


200
201
202
 
# File 'step_functions/map.rb', line 200

def parameters()
  jsii_get_property("parameters")
end

#processor ⇒ AWSCDK::StepFunctions::StateGraph?

Returns:



245
246
247
 
# File 'step_functions/map.rb', line 245

def processor()
  jsii_get_property("processor")
end

#processor=(value) ⇒ Object 



249
250
251
252
 
# File 'step_functions/map.rb', line 249

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:



255
256
257
 
# File 'step_functions/map.rb', line 255

def processor_config()
  jsii_get_property("processorConfig")
end

#processor_config=(value) ⇒ Object 



259
260
261
262
263
 
# File 'step_functions/map.rb', line 259

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:



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

def processor_mode()
  jsii_get_property("processorMode")
end

#processor_mode=(value) ⇒ Object 



270
271
272
273
 
# File 'step_functions/map.rb', line 270

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:



205
206
207
 
# File 'step_functions/map.rb', line 205

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) 


405
406
407
408
 
# File 'step_functions/map.rb', line 405

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) 


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

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) 


421
422
423
424
 
# File 'step_functions/map.rb', line 421

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) 


429
430
431
 
# File 'step_functions/map.rb', line 429

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

#render_item_processor ⇒ Object

Render ItemProcessor in ASL JSON format.

Returns:

  • (Object) 


436
437
438
 
# File 'step_functions/map.rb', line 436

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

#render_iterator ⇒ Object

Render map iterator in ASL JSON format.

Returns:

  • (Object) 


443
444
445
 
# File 'step_functions/map.rb', line 443

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

#render_next_end ⇒ Object

Render the default next state in ASL JSON format.

Returns:

  • (Object) 


450
451
452
 
# File 'step_functions/map.rb', line 450

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) 


458
459
460
461
 
# File 'step_functions/map.rb', line 458

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) 


466
467
468
 
# File 'step_functions/map.rb', line 466

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) 


474
475
476
477
 
# File 'step_functions/map.rb', line 474

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) 


210
211
212
 
# File 'step_functions/map.rb', line 210

def result_path()
  jsii_get_property("resultPath")
end

#result_selector ⇒ Hash?

Returns:

  • (Hash, nil) 


215
216
217
 
# File 'step_functions/map.rb', line 215

def result_selector()
  jsii_get_property("resultSelector")
end

#start_state ⇒ AWSCDK::StepFunctions::State

First state of this Chainable.

Returns:



158
159
160
 
# File 'step_functions/map.rb', line 158

def start_state()
  jsii_get_property("startState")
end

#state_id ⇒ String

Tokenized string that evaluates to the state's ID.

Returns:

  • (String) 


165
166
167
 
# File 'step_functions/map.rb', line 165

def state_id()
  jsii_get_property("stateId")
end

#state_name ⇒ String?

Returns:

  • (String, nil) 


220
221
222
 
# File 'step_functions/map.rb', line 220

def state_name()
  jsii_get_property("stateName")
end

#to_state_json(query_language = nil) ⇒ Hash

Return the Amazon States Language object for this state.

Parameters:

Returns:

  • (Hash) 


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

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


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

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

#validate_state ⇒ Array<String>

Validate this state.

Returns:

  • (Array<String>) 


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

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:



501
502
503
504
 
# File 'step_functions/map.rb', line 501

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



311
312
313
314
315
316
 
# File 'step_functions/map.rb', line 311

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