Class: AWSCDK::StepFunctions::MapJsonataProps

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

Overview

Properties for defining a Map state that using JSONata.

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, outputs: nil, items: nil, parameters: nil) ⇒ MapJsonataProps

Returns a new instance of MapJsonataProps.

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.

  • outputs (Object, nil) (defaults to: nil) —

    Used to specify and transform output from the state.

  • items (AWSCDK::StepFunctions::ProvideItems, nil) (defaults to: nil) —

    The array that the Map state will iterate over.

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

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



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'step_functions/map_jsonata_props.rb', line 19

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, outputs: nil, items: 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?
  @outputs = outputs
  Jsii::Type.check_type(@outputs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "outputs") unless @outputs.nil?
  @items = items
  Jsii::Type.check_type(@items, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5Qcm92aWRlSXRlbXMifQ==")), "items") unless @items.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:



69
70
71
 
# File 'step_functions/map_jsonata_props.rb', line 69

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


48
49
50
 
# File 'step_functions/map_jsonata_props.rb', line 48

def comment
  @comment
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:



75
76
77
 
# File 'step_functions/map_jsonata_props.rb', line 75

def item_selector
  @item_selector
end

#items ⇒ AWSCDK::StepFunctions::ProvideItems? (readonly)

Note:

Default: - The state input as is.

The array that the Map state will iterate over.

Returns:



119
120
121
 
# File 'step_functions/map_jsonata_props.rb', line 119

def items
  @items
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) 


82
83
84
 
# File 'step_functions/map_jsonata_props.rb', line 82

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:



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

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:



102
103
104
 
# File 'step_functions/map_jsonata_props.rb', line 102

def max_concurrency
  @max_concurrency
end

#outputs ⇒ Object? (readonly)

Note:

Default: - $states.result or $states.errorOutput

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.

Returns:

  • (Object, nil)

See Also:



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

def outputs
  @outputs
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:



126
127
128
 
# File 'step_functions/map_jsonata_props.rb', line 126

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:



56
57
58
 
# File 'step_functions/map_jsonata_props.rb', line 56

def query_language
  @query_language
end

#state_name ⇒ String? (readonly)

Note:

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

Optional name for this state.

Returns:

  • (String, nil) 


61
62
63
 
# File 'step_functions/map_jsonata_props.rb', line 61

def state_name
  @state_name
end

Class Method Details

.jsii_properties ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'step_functions/map_jsonata_props.rb', line 128

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",
    :outputs => "outputs",
    :items => "items",
    :parameters => "parameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'step_functions/map_jsonata_props.rb', line 144

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,
    "outputs" => @outputs,
    "items" => @items,
    "parameters" => @parameters,
  })
  result.compact
end