Class: AWSCDK::StepFunctions::JsonataStateOptions

Inherits:
JsonataCommonOptions
  • Object
show all
Defined in:
step_functions/jsonata_state_options.rb

Overview

Option properties for JSONata task state.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(outputs: nil, arguments: nil) ⇒ JsonataStateOptions

Returns a new instance of JsonataStateOptions.

Parameters:

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

    Used to specify and transform output from the state.

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

    Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.



9
10
11
12
13
14
 
# File 'step_functions/jsonata_state_options.rb', line 9

def initialize(outputs: nil, arguments: nil)
  @outputs = outputs
  Jsii::Type.check_type(@outputs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "outputs") unless @outputs.nil?
  @arguments = arguments
  Jsii::Type.check_type(@arguments, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "arguments") unless @arguments.nil?
end

Instance Attribute Details

#arguments ⇒ Object? (readonly)

Note:

Default: - No arguments

Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.

Returns:

  • (Object, nil)

See Also:



33
34
35
 
# File 'step_functions/jsonata_state_options.rb', line 33

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



27
28
29
 
# File 'step_functions/jsonata_state_options.rb', line 27

def outputs
  @outputs
end

Class Method Details

.jsii_properties ⇒ Object 



35
36
37
38
39
40
 
# File 'step_functions/jsonata_state_options.rb', line 35

def self.jsii_properties
  {
    :outputs => "outputs",
    :arguments => "arguments",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



42
43
44
45
46
47
48
49
50
 
# File 'step_functions/jsonata_state_options.rb', line 42

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "outputs" => @outputs,
    "arguments" => @arguments,
  })
  result.compact
end