Class: AWSCDK::StepFunctions::ChoiceProps

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

Overview

Properties for defining a Choice state.

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, input_path: nil, output_path: nil, outputs: nil) ⇒ ChoiceProps

Returns a new instance of ChoiceProps.

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.

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

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

    Used to specify and transform output from the state.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'step_functions/choice_props.rb', line 15

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



57
58
59
 
# File 'step_functions/choice_props.rb', line 57

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


36
37
38
 
# File 'step_functions/choice_props.rb', line 36

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) 


65
66
67
 
# File 'step_functions/choice_props.rb', line 65

def input_path
  @input_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) 


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

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



85
86
87
 
# File 'step_functions/choice_props.rb', line 85

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:



44
45
46
 
# File 'step_functions/choice_props.rb', line 44

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) 


49
50
51
 
# File 'step_functions/choice_props.rb', line 49

def state_name
  @state_name
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :comment => "comment",
    :query_language => "queryLanguage",
    :state_name => "stateName",
    :assign => "assign",
    :input_path => "inputPath",
    :output_path => "outputPath",
    :outputs => "outputs",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'step_functions/choice_props.rb', line 99

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