Class: AWSCDK::StepFunctions::FailJsonataProps

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

Overview

Properties for defining a Fail 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, cause: nil, error: nil) ⇒ FailJsonataProps

Returns a new instance of FailJsonataProps.

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.

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

    Error code used to represent this failure.



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

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

Instance Attribute Details

#cause ⇒ String? (readonly)

Note:

Default: - No description

A description for the cause of the failure.

Returns:

  • (String, nil) 


47
48
49
 
# File 'step_functions/fail_jsonata_props.rb', line 47

def cause
  @cause
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


29
30
31
 
# File 'step_functions/fail_jsonata_props.rb', line 29

def comment
  @comment
end

#error ⇒ String? (readonly)

Note:

Default: - No error code

Error code used to represent this failure.

Returns:

  • (String, nil) 


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

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



37
38
39
 
# File 'step_functions/fail_jsonata_props.rb', line 37

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) 


42
43
44
 
# File 'step_functions/fail_jsonata_props.rb', line 42

def state_name
  @state_name
end

Class Method Details

.jsii_properties ⇒ Object 



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

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

Instance Method Details

#to_jsii ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'step_functions/fail_jsonata_props.rb', line 64

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