Class: AWSCDK::StepFunctions::Timeout

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

Overview

Timeout for a task or heartbeat.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Timeout

Returns a new instance of Timeout.



8
9
10
 
# File 'step_functions/timeout.rb', line 8

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.at(path) ⇒ AWSCDK::StepFunctions::Timeout

Use a dynamic timeout specified by a path in the state input.

The path must select a field whose value is a positive integer.

Parameters:

  • path (String)

Returns:

  • (AWSCDK::StepFunctions::Timeout) 


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

def self.at(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.Timeout", "at", [path])
end

.duration(duration) ⇒ AWSCDK::StepFunctions::Timeout

Use a duration as timeout.

Parameters:

Returns:

  • (AWSCDK::StepFunctions::Timeout) 


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

def self.duration(duration)
  Jsii::Type.check_type(duration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "duration")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.Timeout", "duration", [duration])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
18
 
# File 'step_functions/timeout.rb', line 12

def self.jsii_overridable_methods
  {
    :jsonata_expression => { kind: :property, name: "jsonataExpression", is_optional: true },
    :path => { kind: :property, name: "path", is_optional: true },
    :seconds => { kind: :property, name: "seconds", is_optional: true },
  }
end

.jsonata(jsonata_expression) ⇒ AWSCDK::StepFunctions::Timeout

Use a dynamic timeout specified by a JSONata expression.

The JSONata expression value must be a positive integer.

Parameters:

  • jsonata_expression (String)

Returns:

  • (AWSCDK::StepFunctions::Timeout) 


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

def self.jsonata(jsonata_expression)
  Jsii::Type.check_type(jsonata_expression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jsonataExpression")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.Timeout", "jsonata", [jsonata_expression])
end

Instance Method Details

#jsonata_expression ⇒ String?

JSONata expression for this timeout.

Returns:

  • (String, nil) 


54
55
56
 
# File 'step_functions/timeout.rb', line 54

def jsonata_expression()
  jsii_get_property("jsonataExpression")
end

#path ⇒ String?

Path for this timeout.

Returns:

  • (String, nil) 


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

def path()
  jsii_get_property("path")
end

#seconds ⇒ Numeric?

Seconds for this timeout.

Returns:

  • (Numeric, nil) 


68
69
70
 
# File 'step_functions/timeout.rb', line 68

def seconds()
  jsii_get_property("seconds")
end