Class: AWSCDK::StepFunctions::SucceedJsonataProps

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

Overview

Properties for defining a Succeed 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, outputs: nil) ⇒ SucceedJsonataProps

Returns a new instance of SucceedJsonataProps.

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.



12
13
14
15
16
17
18
19
20
21
 
# File 'step_functions/succeed_jsonata_props.rb', line 12

def initialize(comment: nil, query_language: nil, state_name: nil, outputs: 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?
end

Instance Attribute Details

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


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

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:



52
53
54
 
# File 'step_functions/succeed_jsonata_props.rb', line 52

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:



35
36
37
 
# File 'step_functions/succeed_jsonata_props.rb', line 35

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) 


40
41
42
 
# File 'step_functions/succeed_jsonata_props.rb', line 40

def state_name
  @state_name
end

Class Method Details

.jsii_properties ⇒ Object 



54
55
56
57
58
59
60
61
 
# File 'step_functions/succeed_jsonata_props.rb', line 54

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

Instance Method Details

#to_jsii ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
 
# File 'step_functions/succeed_jsonata_props.rb', line 63

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