Class: AWSCDK::StepFunctions::TaskStateBase

Inherits:
State
  • Object
show all
Includes:
INextable
Defined in:
step_functions/task_state_base.rb

Overview

Define a Task state in the state machine.

Reaching a Task state causes some work to be executed, represented by the Task's resource property. Task constructs represent a generic Amazon States Language Task.

For some resource types, more specific subclasses of Task may be available which are more convenient to use.

Direct Known Subclasses

AWSCDK::StepFunctionsTasks::AthenaGetQueryExecution, AWSCDK::StepFunctionsTasks::AthenaGetQueryResults, AWSCDK::StepFunctionsTasks::AthenaStartQueryExecution, AWSCDK::StepFunctionsTasks::AthenaStopQueryExecution, AWSCDK::StepFunctionsTasks::BatchSubmitJob, AWSCDK::StepFunctionsTasks::BedrockCreateModelCustomizationJob, AWSCDK::StepFunctionsTasks::BedrockInvokeModel, AWSCDK::StepFunctionsTasks::CallAPIGatewayHttpAPIEndpoint, AWSCDK::StepFunctionsTasks::CallAPIGatewayRestAPIEndpoint, AWSCDK::StepFunctionsTasks::CallAWSService, AWSCDK::StepFunctionsTasks::CallAWSServiceCrossRegion, AWSCDK::StepFunctionsTasks::CodeBuildStartBuild, AWSCDK::StepFunctionsTasks::CodeBuildStartBuildBatch, AWSCDK::StepFunctionsTasks::DynamoDeleteItem, AWSCDK::StepFunctionsTasks::DynamoGetItem, AWSCDK::StepFunctionsTasks::DynamoPutItem, AWSCDK::StepFunctionsTasks::DynamoUpdateItem, AWSCDK::StepFunctionsTasks::ECSRunTask, AWSCDK::StepFunctionsTasks::EKSCall, AWSCDK::StepFunctionsTasks::EMRAddStep, AWSCDK::StepFunctionsTasks::EMRCancelStep, AWSCDK::StepFunctionsTasks::EMRContainersCreateVirtualCluster, AWSCDK::StepFunctionsTasks::EMRContainersDeleteVirtualCluster, AWSCDK::StepFunctionsTasks::EMRContainersStartJobRun, AWSCDK::StepFunctionsTasks::EMRCreateCluster, AWSCDK::StepFunctionsTasks::EMRModifyInstanceFleetByName, AWSCDK::StepFunctionsTasks::EMRModifyInstanceGroupByName, AWSCDK::StepFunctionsTasks::EMRSetClusterTerminationProtection, AWSCDK::StepFunctionsTasks::EMRTerminateCluster, AWSCDK::StepFunctionsTasks::EvaluateExpression, AWSCDK::StepFunctionsTasks::EventBridgePutEvents, AWSCDK::StepFunctionsTasks::EventBridgeSchedulerCreateScheduleTask, AWSCDK::StepFunctionsTasks::GlueDataBrewStartJobRun, AWSCDK::StepFunctionsTasks::GlueStartCrawlerRun, AWSCDK::StepFunctionsTasks::GlueStartJobRun, AWSCDK::StepFunctionsTasks::HttpInvoke, AWSCDK::StepFunctionsTasks::LambdaInvoke, AWSCDK::StepFunctionsTasks::MediaConvertCreateJob, AWSCDK::StepFunctionsTasks::SNSPublish, AWSCDK::StepFunctionsTasks::SQSSendMessage, AWSCDK::StepFunctionsTasks::SageMakerCreateEndpoint, AWSCDK::StepFunctionsTasks::SageMakerCreateEndpointConfig, AWSCDK::StepFunctionsTasks::SageMakerCreateModel, AWSCDK::StepFunctionsTasks::SageMakerCreateTrainingJob, AWSCDK::StepFunctionsTasks::SageMakerCreateTransformJob, AWSCDK::StepFunctionsTasks::SageMakerUpdateEndpoint, AWSCDK::StepFunctionsTasks::StepFunctionsInvokeActivity, AWSCDK::StepFunctionsTasks::StepFunctionsStartExecution

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ TaskStateBase

Returns a new instance of TaskStateBase.

Parameters:



19
20
21
22
23
24
25
 
# File 'step_functions/task_state_base.rb', line 19

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::StepFunctions::TaskStateBaseProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrU3RhdGVCYXNlUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'step_functions/task_state_base.rb', line 27

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :branches => { kind: :property, name: "branches", is_optional: false },
    :end_states => { kind: :property, name: "endStates", is_optional: false },
    :id => { kind: :property, name: "id", is_optional: false },
    :start_state => { kind: :property, name: "startState", is_optional: false },
    :state_id => { kind: :property, name: "stateId", is_optional: false },
    :arguments => { kind: :property, name: "arguments", is_optional: true },
    :assign => { kind: :property, name: "assign", is_optional: true },
    :comment => { kind: :property, name: "comment", is_optional: true },
    :input_path => { kind: :property, name: "inputPath", is_optional: true },
    :output_path => { kind: :property, name: "outputPath", is_optional: true },
    :outputs => { kind: :property, name: "outputs", is_optional: true },
    :parameters => { kind: :property, name: "parameters", is_optional: true },
    :query_language => { kind: :property, name: "queryLanguage", is_optional: true },
    :result_path => { kind: :property, name: "resultPath", is_optional: true },
    :result_selector => { kind: :property, name: "resultSelector", is_optional: true },
    :state_name => { kind: :property, name: "stateName", is_optional: true },
    :default_choice => { kind: :property, name: "defaultChoice", is_optional: true },
    :iteration => { kind: :property, name: "iteration", is_optional: true },
    :processor => { kind: :property, name: "processor", is_optional: true },
    :processor_config => { kind: :property, name: "processorConfig", is_optional: true },
    :processor_mode => { kind: :property, name: "processorMode", is_optional: true },
    :task_metrics => { kind: :property, name: "taskMetrics", is_optional: true },
    :task_policies => { kind: :property, name: "taskPolicies", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :add_branch => { kind: :method, name: "addBranch", is_optional: false },
    :add_choice => { kind: :method, name: "addChoice", is_optional: false },
    :add_item_processor => { kind: :method, name: "addItemProcessor", is_optional: false },
    :add_iterator => { kind: :method, name: "addIterator", is_optional: false },
    :add_prefix => { kind: :method, name: "addPrefix", is_optional: false },
    :bind_to_graph => { kind: :method, name: "bindToGraph", is_optional: false },
    :make_default => { kind: :method, name: "makeDefault", is_optional: false },
    :make_next => { kind: :method, name: "makeNext", is_optional: false },
    :render_assign => { kind: :method, name: "renderAssign", is_optional: false },
    :render_branches => { kind: :method, name: "renderBranches", is_optional: false },
    :render_choices => { kind: :method, name: "renderChoices", is_optional: false },
    :render_input_output => { kind: :method, name: "renderInputOutput", is_optional: false },
    :render_item_processor => { kind: :method, name: "renderItemProcessor", is_optional: false },
    :render_iterator => { kind: :method, name: "renderIterator", is_optional: false },
    :render_next_end => { kind: :method, name: "renderNextEnd", is_optional: false },
    :render_query_language => { kind: :method, name: "renderQueryLanguage", is_optional: false },
    :render_result_selector => { kind: :method, name: "renderResultSelector", is_optional: false },
    :render_retry_catch => { kind: :method, name: "renderRetryCatch", is_optional: false },
    :to_state_json => { kind: :method, name: "toStateJson", is_optional: false },
    :validate_state => { kind: :method, name: "validateState", is_optional: false },
    :when_bound_to_graph => { kind: :method, name: "whenBoundToGraph", is_optional: false },
    :add_catch => { kind: :method, name: "addCatch", is_optional: false },
    :add_retry => { kind: :method, name: "addRetry", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
    :metric_failed => { kind: :method, name: "metricFailed", is_optional: false },
    :metric_heartbeat_timed_out => { kind: :method, name: "metricHeartbeatTimedOut", is_optional: false },
    :metric_run_time => { kind: :method, name: "metricRunTime", is_optional: false },
    :metric_scheduled => { kind: :method, name: "metricScheduled", is_optional: false },
    :metric_schedule_time => { kind: :method, name: "metricScheduleTime", is_optional: false },
    :metric_started => { kind: :method, name: "metricStarted", is_optional: false },
    :metric_succeeded => { kind: :method, name: "metricSucceeded", is_optional: false },
    :metric_time => { kind: :method, name: "metricTime", is_optional: false },
    :metric_timed_out => { kind: :method, name: "metricTimedOut", is_optional: false },
    :_next => { kind: :method, name: "next", is_optional: false },
  }
end

Instance Method Details

#_next(_next) ⇒ AWSCDK::StepFunctions::Chain

Continue normal execution with the given state.

Parameters:

Returns:



603
604
605
606
 
# File 'step_functions/task_state_base.rb', line 603

def _next(_next)
  Jsii::Type.check_type(_next, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5JQ2hhaW5hYmxlIn0=")), "next")
  jsii_call_method("next", [_next])
end

#add_branch(branch) ⇒ void

This method returns an undefined value.

Add a parallel branch to this state.

Parameters:



275
276
277
278
 
# File 'step_functions/task_state_base.rb', line 275

def add_branch(branch)
  Jsii::Type.check_type(branch, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZUdyYXBoIn0=")), "branch")
  jsii_call_method("addBranch", [branch])
end

#add_catch(handler, props = nil) ⇒ AWSCDK::StepFunctions::TaskStateBase

Add a recovery handler for this state.

When a particular error occurs, execution will continue at the error handler instead of failing the state machine execution.

Parameters:

Returns:

  • (AWSCDK::StepFunctions::TaskStateBase) 


467
468
469
470
471
472
 
# File 'step_functions/task_state_base.rb', line 467

def add_catch(handler, props = nil)
  Jsii::Type.check_type(handler, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5JQ2hhaW5hYmxlIn0=")), "handler")
  props = props.is_a?(Hash) ? ::AWSCDK::StepFunctions::CatchProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5DYXRjaFByb3BzIn0=")), "props") unless props.nil?
  jsii_call_method("addCatch", [handler, props])
end

#add_choice(condition, _next, options = nil) ⇒ void

This method returns an undefined value.

Add a choice branch to this state.

Parameters:



286
287
288
289
290
291
292
 
# File 'step_functions/task_state_base.rb', line 286

def add_choice(condition, _next, options = nil)
  Jsii::Type.check_type(condition, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5Db25kaXRpb24ifQ==")), "condition")
  Jsii::Type.check_type(_next, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZSJ9")), "next")
  options = options.is_a?(Hash) ? ::AWSCDK::StepFunctions::ChoiceTransitionOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5DaG9pY2VUcmFuc2l0aW9uT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("addChoice", [condition, _next, options])
end

#add_item_processor(processor, config = nil) ⇒ void

This method returns an undefined value.

Add a item processor to this state.

Parameters:



299
300
301
302
303
304
 
# File 'step_functions/task_state_base.rb', line 299

def add_item_processor(processor, config = nil)
  Jsii::Type.check_type(processor, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZUdyYXBoIn0=")), "processor")
  config = config.is_a?(Hash) ? ::AWSCDK::StepFunctions::ProcessorConfig.new(**config.transform_keys(&:to_sym)) : config
  Jsii::Type.check_type(config, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5Qcm9jZXNzb3JDb25maWcifQ==")), "config") unless config.nil?
  jsii_call_method("addItemProcessor", [processor, config])
end

#add_iterator(iteration) ⇒ void

This method returns an undefined value.

Add a map iterator to this state.

Parameters:



310
311
312
313
 
# File 'step_functions/task_state_base.rb', line 310

def add_iterator(iteration)
  Jsii::Type.check_type(iteration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZUdyYXBoIn0=")), "iteration")
  jsii_call_method("addIterator", [iteration])
end

#add_prefix(x) ⇒ void

This method returns an undefined value.

Add a prefix to the stateId of this state.

Parameters:

  • x (String) 


319
320
321
322
 
# File 'step_functions/task_state_base.rb', line 319

def add_prefix(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "x")
  jsii_call_method("addPrefix", [x])
end

#add_retry(props = nil) ⇒ AWSCDK::StepFunctions::TaskStateBase

Add retry configuration for this state.

This controls if and how the execution will be retried if a particular error occurs.

Parameters:

Returns:

  • (AWSCDK::StepFunctions::TaskStateBase) 


481
482
483
484
485
 
# File 'step_functions/task_state_base.rb', line 481

def add_retry(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::StepFunctions::RetryProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5SZXRyeVByb3BzIn0=")), "props") unless props.nil?
  jsii_call_method("addRetry", [props])
end

#arguments ⇒ Hash?

Returns:

  • (Hash, nil) 


133
134
135
 
# File 'step_functions/task_state_base.rb', line 133

def arguments()
  jsii_get_property("arguments")
end

#assign ⇒ Hash?

Returns:

  • (Hash, nil) 


138
139
140
 
# File 'step_functions/task_state_base.rb', line 138

def assign()
  jsii_get_property("assign")
end

#bind_to_graph(graph) ⇒ void

This method returns an undefined value.

Register this state as part of the given graph.

Don't call this. It will be called automatically when you work with states normally.

Parameters:



331
332
333
334
 
# File 'step_functions/task_state_base.rb', line 331

def bind_to_graph(graph)
  Jsii::Type.check_type(graph, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZUdyYXBoIn0=")), "graph")
  jsii_call_method("bindToGraph", [graph])
end

#branches ⇒ Array<AWSCDK::StepFunctions::StateGraph>

Returns:



100
101
102
 
# File 'step_functions/task_state_base.rb', line 100

def branches()
  jsii_get_property("branches")
end

#comment ⇒ String?

Returns:

  • (String, nil) 


143
144
145
 
# File 'step_functions/task_state_base.rb', line 143

def comment()
  jsii_get_property("comment")
end

#default_choice ⇒ AWSCDK::StepFunctions::State?

Returns:



188
189
190
 
# File 'step_functions/task_state_base.rb', line 188

def default_choice()
  jsii_get_property("defaultChoice")
end

#default_choice=(value) ⇒ Object 



192
193
194
195
 
# File 'step_functions/task_state_base.rb', line 192

def default_choice=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZSJ9")), "defaultChoice") unless value.nil?
  jsii_set_property("defaultChoice", value)
end

#end_states ⇒ Array<AWSCDK::StepFunctions::INextable>

Continuable states of this Chainable.

Returns:



107
108
109
 
# File 'step_functions/task_state_base.rb', line 107

def end_states()
  jsii_get_property("endStates")
end

#id ⇒ String

Descriptive identifier for this chainable.

Returns:

  • (String) 


114
115
116
 
# File 'step_functions/task_state_base.rb', line 114

def id()
  jsii_get_property("id")
end

#input_path ⇒ String?

Returns:

  • (String, nil) 


148
149
150
 
# File 'step_functions/task_state_base.rb', line 148

def input_path()
  jsii_get_property("inputPath")
end

#iteration ⇒ AWSCDK::StepFunctions::StateGraph?

Returns:



198
199
200
 
# File 'step_functions/task_state_base.rb', line 198

def iteration()
  jsii_get_property("iteration")
end

#iteration=(value) ⇒ Object 



202
203
204
205
 
# File 'step_functions/task_state_base.rb', line 202

def iteration=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZUdyYXBoIn0=")), "iteration") unless value.nil?
  jsii_set_property("iteration", value)
end

#make_default(_def) ⇒ void

This method returns an undefined value.

Make the indicated state the default choice transition of this state.

Parameters:



340
341
342
343
 
# File 'step_functions/task_state_base.rb', line 340

def make_default(_def)
  Jsii::Type.check_type(_def, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZSJ9")), "def")
  jsii_call_method("makeDefault", [_def])
end

#make_next(_next) ⇒ void

This method returns an undefined value.

Make the indicated state the default transition of this state.

Parameters:



349
350
351
352
 
# File 'step_functions/task_state_base.rb', line 349

def make_next(_next)
  Jsii::Type.check_type(_next, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZSJ9")), "next")
  jsii_call_method("makeNext", [_next])
end

#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - sum over 5 minutes

Return the given named metric for this Task.

Parameters:

Returns:



493
494
495
496
497
498
 
# File 'step_functions/task_state_base.rb', line 493

def metric(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metric", [metric_name, props])
end

#metric_failed(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - sum over 5 minutes

Metric for the number of times this activity fails.

Parameters:

Returns:



505
506
507
508
509
 
# File 'step_functions/task_state_base.rb', line 505

def metric_failed(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricFailed", [props])
end

#metric_heartbeat_timed_out(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - sum over 5 minutes

Metric for the number of times the heartbeat times out for this activity.

Parameters:

Returns:



516
517
518
519
520
 
# File 'step_functions/task_state_base.rb', line 516

def metric_heartbeat_timed_out(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricHeartbeatTimedOut", [props])
end

#metric_run_time(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - average over 5 minutes

The interval, in milliseconds, between the time the Task starts and the time it closes.

Parameters:

Returns:



527
528
529
530
531
 
# File 'step_functions/task_state_base.rb', line 527

def metric_run_time(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricRunTime", [props])
end

#metric_schedule_time(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - average over 5 minutes

The interval, in milliseconds, for which the activity stays in the schedule state.

Parameters:

Returns:



549
550
551
552
553
 
# File 'step_functions/task_state_base.rb', line 549

def metric_schedule_time(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricScheduleTime", [props])
end

#metric_scheduled(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - sum over 5 minutes

Metric for the number of times this activity is scheduled.

Parameters:

Returns:



538
539
540
541
542
 
# File 'step_functions/task_state_base.rb', line 538

def metric_scheduled(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricScheduled", [props])
end

#metric_started(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - sum over 5 minutes

Metric for the number of times this activity is started.

Parameters:

Returns:



560
561
562
563
564
 
# File 'step_functions/task_state_base.rb', line 560

def metric_started(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricStarted", [props])
end

#metric_succeeded(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - sum over 5 minutes

Metric for the number of times this activity succeeds.

Parameters:

Returns:



571
572
573
574
575
 
# File 'step_functions/task_state_base.rb', line 571

def metric_succeeded(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricSucceeded", [props])
end

#metric_time(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - average over 5 minutes

The interval, in milliseconds, between the time the activity is scheduled and the time it closes.

Parameters:

Returns:



582
583
584
585
586
 
# File 'step_functions/task_state_base.rb', line 582

def metric_time(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricTime", [props])
end

#metric_timed_out(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - sum over 5 minutes

Metric for the number of times this activity times out.

Parameters:

Returns:



593
594
595
596
597
 
# File 'step_functions/task_state_base.rb', line 593

def metric_timed_out(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricTimedOut", [props])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


95
96
97
 
# File 'step_functions/task_state_base.rb', line 95

def node()
  jsii_get_property("node")
end

#output_path ⇒ String?

Returns:

  • (String, nil) 


153
154
155
 
# File 'step_functions/task_state_base.rb', line 153

def output_path()
  jsii_get_property("outputPath")
end

#outputs ⇒ Hash?

Returns:

  • (Hash, nil) 


158
159
160
 
# File 'step_functions/task_state_base.rb', line 158

def outputs()
  jsii_get_property("outputs")
end

#parameters ⇒ Hash?

Returns:

  • (Hash, nil) 


163
164
165
 
# File 'step_functions/task_state_base.rb', line 163

def parameters()
  jsii_get_property("parameters")
end

#processor ⇒ AWSCDK::StepFunctions::StateGraph?

Returns:



208
209
210
 
# File 'step_functions/task_state_base.rb', line 208

def processor()
  jsii_get_property("processor")
end

#processor=(value) ⇒ Object 



212
213
214
215
 
# File 'step_functions/task_state_base.rb', line 212

def processor=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZUdyYXBoIn0=")), "processor") unless value.nil?
  jsii_set_property("processor", value)
end

#processor_config ⇒ AWSCDK::StepFunctions::ProcessorConfig?

Returns:



218
219
220
 
# File 'step_functions/task_state_base.rb', line 218

def processor_config()
  jsii_get_property("processorConfig")
end

#processor_config=(value) ⇒ Object 



222
223
224
225
226
 
# File 'step_functions/task_state_base.rb', line 222

def processor_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::StepFunctions::ProcessorConfig.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5Qcm9jZXNzb3JDb25maWcifQ==")), "processorConfig") unless value.nil?
  jsii_set_property("processorConfig", value)
end

#processor_mode ⇒ AWSCDK::StepFunctions::ProcessorMode?

Returns:



229
230
231
 
# File 'step_functions/task_state_base.rb', line 229

def processor_mode()
  jsii_get_property("processorMode")
end

#processor_mode=(value) ⇒ Object 



233
234
235
236
 
# File 'step_functions/task_state_base.rb', line 233

def processor_mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5Qcm9jZXNzb3JNb2RlIn0=")), "processorMode") unless value.nil?
  jsii_set_property("processorMode", value)
end

#query_language ⇒ AWSCDK::StepFunctions::QueryLanguage?

Returns:



168
169
170
 
# File 'step_functions/task_state_base.rb', line 168

def query_language()
  jsii_get_property("queryLanguage")
end

#render_assign(top_level_query_language = nil) ⇒ Object

Render the assign in ASL JSON format.

Parameters:

Returns:

  • (Object) 


358
359
360
361
 
# File 'step_functions/task_state_base.rb', line 358

def render_assign(top_level_query_language = nil)
  Jsii::Type.check_type(top_level_query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "topLevelQueryLanguage") unless top_level_query_language.nil?
  jsii_call_method("renderAssign", [top_level_query_language])
end

#render_branches ⇒ Object

Render parallel branches in ASL JSON format.

Returns:

  • (Object) 


366
367
368
 
# File 'step_functions/task_state_base.rb', line 366

def render_branches()
  jsii_call_method("renderBranches", [])
end

#render_choices(top_level_query_language = nil) ⇒ Object

Render the choices in ASL JSON format.

Parameters:

Returns:

  • (Object) 


374
375
376
377
 
# File 'step_functions/task_state_base.rb', line 374

def render_choices(top_level_query_language = nil)
  Jsii::Type.check_type(top_level_query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "topLevelQueryLanguage") unless top_level_query_language.nil?
  jsii_call_method("renderChoices", [top_level_query_language])
end

#render_input_output ⇒ Object

Render InputPath/Parameters/OutputPath/Arguments/Output in ASL JSON format.

Returns:

  • (Object) 


382
383
384
 
# File 'step_functions/task_state_base.rb', line 382

def render_input_output()
  jsii_call_method("renderInputOutput", [])
end

#render_item_processor ⇒ Object

Render ItemProcessor in ASL JSON format.

Returns:

  • (Object) 


389
390
391
 
# File 'step_functions/task_state_base.rb', line 389

def render_item_processor()
  jsii_call_method("renderItemProcessor", [])
end

#render_iterator ⇒ Object

Render map iterator in ASL JSON format.

Returns:

  • (Object) 


396
397
398
 
# File 'step_functions/task_state_base.rb', line 396

def render_iterator()
  jsii_call_method("renderIterator", [])
end

#render_next_end ⇒ Object

Render the default next state in ASL JSON format.

Returns:

  • (Object) 


403
404
405
 
# File 'step_functions/task_state_base.rb', line 403

def render_next_end()
  jsii_call_method("renderNextEnd", [])
end

#render_query_language(top_level_query_language = nil) ⇒ Object

Render QueryLanguage in ASL JSON format if needed.

Parameters:

Returns:

  • (Object) 


411
412
413
414
 
# File 'step_functions/task_state_base.rb', line 411

def render_query_language(top_level_query_language = nil)
  Jsii::Type.check_type(top_level_query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "topLevelQueryLanguage") unless top_level_query_language.nil?
  jsii_call_method("renderQueryLanguage", [top_level_query_language])
end

#render_result_selector ⇒ Object

Render ResultSelector in ASL JSON format.

Returns:

  • (Object) 


419
420
421
 
# File 'step_functions/task_state_base.rb', line 419

def render_result_selector()
  jsii_call_method("renderResultSelector", [])
end

#render_retry_catch(top_level_query_language = nil) ⇒ Object

Render error recovery options in ASL JSON format.

Parameters:

Returns:

  • (Object) 


427
428
429
430
 
# File 'step_functions/task_state_base.rb', line 427

def render_retry_catch(top_level_query_language = nil)
  Jsii::Type.check_type(top_level_query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "topLevelQueryLanguage") unless top_level_query_language.nil?
  jsii_call_method("renderRetryCatch", [top_level_query_language])
end

#result_path ⇒ String?

Returns:

  • (String, nil) 


173
174
175
 
# File 'step_functions/task_state_base.rb', line 173

def result_path()
  jsii_get_property("resultPath")
end

#result_selector ⇒ Hash?

Returns:

  • (Hash, nil) 


178
179
180
 
# File 'step_functions/task_state_base.rb', line 178

def result_selector()
  jsii_get_property("resultSelector")
end

#start_state ⇒ AWSCDK::StepFunctions::State

First state of this Chainable.

Returns:



121
122
123
 
# File 'step_functions/task_state_base.rb', line 121

def start_state()
  jsii_get_property("startState")
end

#state_id ⇒ String

Tokenized string that evaluates to the state's ID.

Returns:

  • (String) 


128
129
130
 
# File 'step_functions/task_state_base.rb', line 128

def state_id()
  jsii_get_property("stateId")
end

#state_name ⇒ String?

Returns:

  • (String, nil) 


183
184
185
 
# File 'step_functions/task_state_base.rb', line 183

def state_name()
  jsii_get_property("stateName")
end

#task_metrics ⇒ AWSCDK::StepFunctions::TaskMetricsConfig?

Returns:



239
240
241
 
# File 'step_functions/task_state_base.rb', line 239

def task_metrics()
  jsii_get_property("taskMetrics")
end

#task_policies ⇒ Array<AWSCDK::IAM::PolicyStatement>?

Returns:



244
245
246
 
# File 'step_functions/task_state_base.rb', line 244

def task_policies()
  jsii_get_property("taskPolicies")
end

#to_state_json(top_level_query_language = nil) ⇒ Hash

Return the Amazon States Language object for this state.

Parameters:

Returns:

  • (Hash) 


436
437
438
439
 
# File 'step_functions/task_state_base.rb', line 436

def to_state_json(top_level_query_language = nil)
  Jsii::Type.check_type(top_level_query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "topLevelQueryLanguage") unless top_level_query_language.nil?
  jsii_call_method("toStateJson", [top_level_query_language])
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


251
252
253
 
# File 'step_functions/task_state_base.rb', line 251

def to_string()
  jsii_call_method("toString", [])
end

#validate_state ⇒ Array<String>

Allows the state to validate itself.

Returns:

  • (Array<String>) 


444
445
446
 
# File 'step_functions/task_state_base.rb', line 444

def validate_state()
  jsii_call_method("validateState", [])
end

#when_bound_to_graph(graph) ⇒ void

This method returns an undefined value.

Called whenever this state is bound to a graph.

Can be overridden by subclasses.

Parameters:



454
455
456
457
 
# File 'step_functions/task_state_base.rb', line 454

def when_bound_to_graph(graph)
  Jsii::Type.check_type(graph, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZUdyYXBoIn0=")), "graph")
  jsii_call_method("whenBoundToGraph", [graph])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



264
265
266
267
268
269
 
# File 'step_functions/task_state_base.rb', line 264

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end