Class: AWSCDK::StepFunctions::FailJsonPathProps

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

Overview

Properties for defining a Fail state that using JSONPath.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(comment: nil, query_language: nil, state_name: nil, cause: nil, cause_path: nil, error: nil, error_path: nil) ⇒ FailJsonPathProps

Returns a new instance of FailJsonPathProps.

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.

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

    A description for the cause of the failure.

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

    JsonPath expression to select part of the state to be the cause to this state.

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

    Error code used to represent this failure.

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

    JsonPath expression to select part of the state to be the error to this state.



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

def initialize(comment: nil, query_language: nil, state_name: nil, cause: nil, cause_path: nil, error: nil, error_path: 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?
  @cause = cause
  Jsii::Type.check_type(@cause, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cause") unless @cause.nil?
  @cause_path = cause_path
  Jsii::Type.check_type(@cause_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "causePath") unless @cause_path.nil?
  @error = error
  Jsii::Type.check_type(@error, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "error") unless @error.nil?
  @error_path = error_path
  Jsii::Type.check_type(@error_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "errorPath") unless @error_path.nil?
end

Instance Attribute Details

#cause ⇒ String? (readonly)

Note:

Default: - No description

A description for the cause of the failure.

Returns:

  • (String, nil) 


53
54
55
 
# File 'step_functions/fail_json_path_props.rb', line 53

def cause
  @cause
end

#cause_path ⇒ String? (readonly)

Note:

Default: - No cause path

JsonPath expression to select part of the state to be the cause to this state.

You can also use an intrinsic function that returns a string to specify this property. The allowed functions include States.Format, States.JsonToString, States.ArrayGetItem, States.Base64Encode, States.Base64Decode, States.Hash, and States.UUID.

Returns:

  • (String, nil) 


61
62
63
 
# File 'step_functions/fail_json_path_props.rb', line 61

def cause_path
  @cause_path
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


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

def comment
  @comment
end

#error ⇒ String? (readonly)

Note:

Default: - No error code

Error code used to represent this failure.

Returns:

  • (String, nil) 


66
67
68
 
# File 'step_functions/fail_json_path_props.rb', line 66

def error
  @error
end

#error_path ⇒ String? (readonly)

Note:

Default: - No error path

JsonPath expression to select part of the state to be the error to this state.

You can also use an intrinsic function that returns a string to specify this property. The allowed functions include States.Format, States.JsonToString, States.ArrayGetItem, States.Base64Encode, States.Base64Decode, States.Hash, and States.UUID.

Returns:

  • (String, nil) 


74
75
76
 
# File 'step_functions/fail_json_path_props.rb', line 74

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



43
44
45
 
# File 'step_functions/fail_json_path_props.rb', line 43

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) 


48
49
50
 
# File 'step_functions/fail_json_path_props.rb', line 48

def state_name
  @state_name
end

Class Method Details

.jsii_properties ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
 
# File 'step_functions/fail_json_path_props.rb', line 76

def self.jsii_properties
  {
    :comment => "comment",
    :query_language => "queryLanguage",
    :state_name => "stateName",
    :cause => "cause",
    :cause_path => "causePath",
    :error => "error",
    :error_path => "errorPath",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'step_functions/fail_json_path_props.rb', line 88

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "comment" => @comment,
    "queryLanguage" => @query_language,
    "stateName" => @state_name,
    "cause" => @cause,
    "causePath" => @cause_path,
    "error" => @error,
    "errorPath" => @error_path,
  })
  result.compact
end