Class: AWSCDK::StepFunctions::JsonPathCommonOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
step_functions/json_path_common_options.rb

Overview

Option properties for JSONPath state.

Direct Known Subclasses

MapBaseJsonPathOptions

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(input_path: nil, output_path: nil) ⇒ JsonPathCommonOptions

Returns a new instance of JsonPathCommonOptions.

Parameters:

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



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

def initialize(input_path: nil, output_path: 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?
end

Instance Attribute Details

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


23
24
25
 
# File 'step_functions/json_path_common_options.rb', line 23

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) 


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

def output_path
  @output_path
end

Class Method Details

.jsii_properties ⇒ Object 



33
34
35
36
37
38
 
# File 'step_functions/json_path_common_options.rb', line 33

def self.jsii_properties
  {
    :input_path => "inputPath",
    :output_path => "outputPath",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



40
41
42
43
44
45
46
47
 
# File 'step_functions/json_path_common_options.rb', line 40

def to_jsii
  result = {}
  result.merge!({
    "inputPath" => @input_path,
    "outputPath" => @output_path,
  })
  result.compact
end