Class: AWSCDK::StepFunctions::MapJsonPathProps

Inherits:
StateBaseProps
  • Object
show all
Defined in:
step_functions/map_json_path_props.rb

Overview

Properties for defining a Map state that using JSONPath.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(comment: nil, query_language: nil, state_name: nil, assign: nil, item_selector: nil, jsonata_item_selector: nil, jsonata_max_concurrency: nil, max_concurrency: nil, input_path: nil, output_path: nil, items_path: nil, max_concurrency_path: nil, result_path: nil, result_selector: nil, parameters: nil) ⇒ MapJsonPathProps

Returns a new instance of MapJsonPathProps.

Parameters:

  • comment (String, nil) (defaults to: nil) —

    A comment describing this state.

  • query_language (AWSCDK::StepFunctions::QueryLanguage, nil) (defaults to: nil) —

    The name of the query language used by the state.

  • state_name (String, nil) (defaults to: nil) —

    Optional name for this state.

  • assign (Hash{String => Object}, nil) (defaults to: nil) —

    Workflow variables to store in this step.

  • item_selector (Hash{String => Object}, nil) (defaults to: nil) —

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

  • jsonata_item_selector (String, nil) (defaults to: nil) —

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

  • jsonata_max_concurrency (String, nil) (defaults to: nil) —

    JSONata expression for MaxConcurrency.

  • max_concurrency (Numeric, nil) (defaults to: nil) —

    MaxConcurrency.

  • input_path (String, nil) (defaults to: nil) —

    JSONPath expression to select part of the state to be the input to this state.

  • output_path (String, nil) (defaults to: nil) —

    JSONPath expression to select part of the state to be the output to this state.

  • items_path (String, nil) (defaults to: nil) —

    JSONPath expression to select the array to iterate over.

  • max_concurrency_path (String, nil) (defaults to: nil) —

    MaxConcurrencyPath.

  • result_path (String, nil) (defaults to: nil) —

    JSONPath expression to indicate where to inject the state's output.

  • result_selector (Hash{String => Object}, nil) (defaults to: nil) —

    The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

  • parameters (Hash{String => Object}, nil) (defaults to: nil) —

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



23
24
25
26
27
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
 
# File 'step_functions/map_json_path_props.rb', line 23

def initialize(comment: nil, query_language: nil, state_name: nil, assign: nil, item_selector: nil, jsonata_item_selector: nil, jsonata_max_concurrency: nil, max_concurrency: nil, input_path: nil, output_path: nil, items_path: nil, max_concurrency_path: nil, result_path: nil, result_selector: nil, parameters: nil)
  @comment = comment
  Jsii::Type.check_type(@comment, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "comment") unless @comment.nil?
  @query_language = query_language
  Jsii::Type.check_type(@query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "queryLanguage") unless @query_language.nil?
  @state_name = state_name
  Jsii::Type.check_type(@state_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stateName") unless @state_name.nil?
  @assign = assign
  Jsii::Type.check_type(@assign, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "assign") unless @assign.nil?
  @item_selector = item_selector
  Jsii::Type.check_type(@item_selector, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "itemSelector") unless @item_selector.nil?
  @jsonata_item_selector = jsonata_item_selector
  Jsii::Type.check_type(@jsonata_item_selector, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jsonataItemSelector") unless @jsonata_item_selector.nil?
  @jsonata_max_concurrency = jsonata_max_concurrency
  Jsii::Type.check_type(@jsonata_max_concurrency, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jsonataMaxConcurrency") unless @jsonata_max_concurrency.nil?
  @max_concurrency = max_concurrency
  Jsii::Type.check_type(@max_concurrency, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxConcurrency") unless @max_concurrency.nil?
  @input_path = input_path
  Jsii::Type.check_type(@input_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputPath") unless @input_path.nil?
  @output_path = output_path
  Jsii::Type.check_type(@output_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputPath") unless @output_path.nil?
  @items_path = items_path
  Jsii::Type.check_type(@items_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "itemsPath") unless @items_path.nil?
  @max_concurrency_path = max_concurrency_path
  Jsii::Type.check_type(@max_concurrency_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "maxConcurrencyPath") unless @max_concurrency_path.nil?
  @result_path = result_path
  Jsii::Type.check_type(@result_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resultPath") unless @result_path.nil?
  @result_selector = result_selector
  Jsii::Type.check_type(@result_selector, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "resultSelector") unless @result_selector.nil?
  @parameters = parameters
  Jsii::Type.check_type(@parameters, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "parameters") unless @parameters.nil?
end

Instance Attribute Details

#assign ⇒ Hash{String => Object}? (readonly)

Note:

Default: - Not assign variables

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Returns:

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

See Also:



81
82
83
 
# File 'step_functions/map_json_path_props.rb', line 81

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


60
61
62
 
# File 'step_functions/map_json_path_props.rb', line 60

def comment
  @comment
end

#input_path ⇒ String? (readonly)

Note:

Default: $

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 {}.

Returns:

  • (String, nil) 


122
123
124
 
# File 'step_functions/map_json_path_props.rb', line 122

def input_path
  @input_path
end

#item_selector ⇒ Hash{String => Object}? (readonly)

Note:

Default: $

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

Returns:

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

See Also:



87
88
89
 
# File 'step_functions/map_json_path_props.rb', line 87

def item_selector
  @item_selector
end

#items_path ⇒ String? (readonly)

Note:

Default: $

JSONPath expression to select the array to iterate over.

Returns:

  • (String, nil) 


135
136
137
 
# File 'step_functions/map_json_path_props.rb', line 135

def items_path
  @items_path
end

#jsonata_item_selector ⇒ String? (readonly)

Note:

Default: $

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} %}

Returns:

  • (String, nil) 


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

def jsonata_item_selector
  @jsonata_item_selector
end

#jsonata_max_concurrency ⇒ String? (readonly)

Note:

Default: - full concurrency

JSONata expression for MaxConcurrency.

A JSONata expression that evaluates to an integer, specifying the maximum concurrency dynamically. Mutually exclusive with max_concurrency and max_concurrency_path.

Example value: {% $states.input.maxConcurrency %}

Returns:

  • (String, nil)

See Also:



106
107
108
 
# File 'step_functions/map_json_path_props.rb', line 106

def jsonata_max_concurrency
  @jsonata_max_concurrency
end

#max_concurrency ⇒ Numeric? (readonly)

Note:

Default: - full concurrency

MaxConcurrency.

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

Returns:

  • (Numeric, nil)

See Also:



114
115
116
 
# File 'step_functions/map_json_path_props.rb', line 114

def max_concurrency
  @max_concurrency
end

#max_concurrency_path ⇒ String? (readonly)

Note:

Default: - full concurrency

MaxConcurrencyPath.

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

Returns:

  • (String, nil)

See Also:



143
144
145
 
# File 'step_functions/map_json_path_props.rb', line 143

def max_concurrency_path
  @max_concurrency_path
end

#output_path ⇒ String? (readonly)

Note:

Default: $

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 {}.

Returns:

  • (String, nil) 


130
131
132
 
# File 'step_functions/map_json_path_props.rb', line 130

def output_path
  @output_path
end

#parameters ⇒ Hash{String => Object}? (readonly)

Deprecated.

Step Functions has deprecated the parameters field in favor of the new itemSelector field

Note:

Default: $

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

Returns:

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

See Also:



167
168
169
 
# File 'step_functions/map_json_path_props.rb', line 167

def parameters
  @parameters
end

#query_language ⇒ AWSCDK::StepFunctions::QueryLanguage? (readonly)

Note:

Default: - JSONPath

The name of the query language used by the state.

If the state does not contain a query_language field, then it will use the query language specified in the top-level query_language field.

Returns:



68
69
70
 
# File 'step_functions/map_json_path_props.rb', line 68

def query_language
  @query_language
end

#result_path ⇒ String? (readonly)

Note:

Default: $

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.

Returns:

  • (String, nil) 


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

def result_path
  @result_path
end

#result_selector ⇒ Hash{String => Object}? (readonly)

Note:

Default: - None

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.

Returns:

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

See Also:



160
161
162
 
# File 'step_functions/map_json_path_props.rb', line 160

def result_selector
  @result_selector
end

#state_name ⇒ String? (readonly)

Note:

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

Optional name for this state.

Returns:

  • (String, nil) 


73
74
75
 
# File 'step_functions/map_json_path_props.rb', line 73

def state_name
  @state_name
end

Class Method Details

.jsii_properties ⇒ Object 



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'step_functions/map_json_path_props.rb', line 169

def self.jsii_properties
  {
    :comment => "comment",
    :query_language => "queryLanguage",
    :state_name => "stateName",
    :assign => "assign",
    :item_selector => "itemSelector",
    :jsonata_item_selector => "jsonataItemSelector",
    :jsonata_max_concurrency => "jsonataMaxConcurrency",
    :max_concurrency => "maxConcurrency",
    :input_path => "inputPath",
    :output_path => "outputPath",
    :items_path => "itemsPath",
    :max_concurrency_path => "maxConcurrencyPath",
    :result_path => "resultPath",
    :result_selector => "resultSelector",
    :parameters => "parameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'step_functions/map_json_path_props.rb', line 189

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "comment" => @comment,
    "queryLanguage" => @query_language,
    "stateName" => @state_name,
    "assign" => @assign,
    "itemSelector" => @item_selector,
    "jsonataItemSelector" => @jsonata_item_selector,
    "jsonataMaxConcurrency" => @jsonata_max_concurrency,
    "maxConcurrency" => @max_concurrency,
    "inputPath" => @input_path,
    "outputPath" => @output_path,
    "itemsPath" => @items_path,
    "maxConcurrencyPath" => @max_concurrency_path,
    "resultPath" => @result_path,
    "resultSelector" => @result_selector,
    "parameters" => @parameters,
  })
  result.compact
end