Class: AWSCDK::StepFunctions::ChoiceTransitionOptions

Inherits:
AssignableStateOptions
  • Object
show all
Defined in:
step_functions/choice_transition_options.rb

Overview

Options for Choice Transition.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(assign: nil, comment: nil, outputs: nil) ⇒ ChoiceTransitionOptions

Returns a new instance of ChoiceTransitionOptions.

Parameters:

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

    Workflow variables to store in this step.

  • comment (String, nil) (defaults to: nil) —

    An optional description for the choice transition.

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

    This option for JSONata only.



10
11
12
13
14
15
16
17
 
# File 'step_functions/choice_transition_options.rb', line 10

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



26
27
28
 
# File 'step_functions/choice_transition_options.rb', line 26

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

An optional description for the choice transition.

Returns:

  • (String, nil) 


31
32
33
 
# File 'step_functions/choice_transition_options.rb', line 31

def comment
  @comment
end

#outputs ⇒ Object? (readonly)

Note:

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

This option for JSONata only.

When you use JSONPath, then the state ignores this property. 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:



45
46
47
 
# File 'step_functions/choice_transition_options.rb', line 45

def outputs
  @outputs
end

Class Method Details

.jsii_properties ⇒ Object 



47
48
49
50
51
52
53
 
# File 'step_functions/choice_transition_options.rb', line 47

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

Instance Method Details

#to_jsii ⇒ Object 



55
56
57
58
59
60
61
62
63
64
 
# File 'step_functions/choice_transition_options.rb', line 55

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