Class: AWSCDK::StepFunctions::JsonataStateProps

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

Overview

Properties shared by all states that use JSONata.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(comment: nil, query_language: nil, state_name: nil, outputs: nil, arguments: nil, assign: nil) ⇒ JsonataStateProps

Returns a new instance of JsonataStateProps.

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.

  • 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.

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

    Workflow variables to store in this step.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'step_functions/jsonata_state_props.rb', line 14

def initialize(comment: nil, query_language: nil, state_name: nil, outputs: nil, arguments: nil, assign: 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?
  @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?
  @assign = assign
  Jsii::Type.check_type(@assign, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "assign") unless @assign.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:



64
65
66
 
# File 'step_functions/jsonata_state_props.rb', line 64

def arguments
  @arguments
end

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



72
73
74
 
# File 'step_functions/jsonata_state_props.rb', line 72

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


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

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



58
59
60
 
# File 'step_functions/jsonata_state_props.rb', line 58

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



41
42
43
 
# File 'step_functions/jsonata_state_props.rb', line 41

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) 


46
47
48
 
# File 'step_functions/jsonata_state_props.rb', line 46

def state_name
  @state_name
end

Class Method Details

.jsii_properties ⇒ Object 



74
75
76
77
78
79
80
81
82
83
 
# File 'step_functions/jsonata_state_props.rb', line 74

def self.jsii_properties
  {
    :comment => "comment",
    :query_language => "queryLanguage",
    :state_name => "stateName",
    :outputs => "outputs",
    :arguments => "arguments",
    :assign => "assign",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'step_functions/jsonata_state_props.rb', line 85

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "comment" => @comment,
    "queryLanguage" => @query_language,
    "stateName" => @state_name,
    "outputs" => @outputs,
    "arguments" => @arguments,
    "assign" => @assign,
  })
  result.compact
end