Class: AWSCDK::StepFunctions::WaitProps

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

Overview

Properties for defining a Wait 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, time:) ⇒ WaitProps

Returns a new instance of WaitProps.

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.

  • time (AWSCDK::StepFunctions::WaitTime) —

    Wait duration.



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

def initialize(comment: nil, query_language: nil, state_name: nil, assign: nil, time:)
  @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?
  @time = time
  Jsii::Type.check_type(@time, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5XYWl0VGltZSJ9")), "time")
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:



51
52
53
 
# File 'step_functions/wait_props.rb', line 51

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


30
31
32
 
# File 'step_functions/wait_props.rb', line 30

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



38
39
40
 
# File 'step_functions/wait_props.rb', line 38

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) 


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

def state_name
  @state_name
end

#time ⇒ AWSCDK::StepFunctions::WaitTime (readonly)

Wait duration.

Returns:



55
56
57
 
# File 'step_functions/wait_props.rb', line 55

def time
  @time
end

Class Method Details

.jsii_properties ⇒ Object 



57
58
59
60
61
62
63
64
65
 
# File 'step_functions/wait_props.rb', line 57

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

Instance Method Details

#to_jsii ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'step_functions/wait_props.rb', line 67

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