Class: AWSCDK::StepFunctions::TaskStateJsonPathBaseProps

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

Overview

Props that are common to all tasks that using JSONPath.

Direct Known Subclasses

AWSCDK::StepFunctionsTasks::AthenaGetQueryExecutionJsonPathProps, AWSCDK::StepFunctionsTasks::AthenaGetQueryResultsJsonPathProps, AWSCDK::StepFunctionsTasks::AthenaStartQueryExecutionJsonPathProps, AWSCDK::StepFunctionsTasks::AthenaStopQueryExecutionJsonPathProps, AWSCDK::StepFunctionsTasks::BatchSubmitJobJsonPathProps, AWSCDK::StepFunctionsTasks::BedrockInvokeModelJsonPathProps, AWSCDK::StepFunctionsTasks::CallAPIGatewayEndpointJsonPathBaseProps, AWSCDK::StepFunctionsTasks::CallAWSServiceCrossRegionJsonPathProps, AWSCDK::StepFunctionsTasks::CallAWSServiceJsonPathProps, AWSCDK::StepFunctionsTasks::CodeBuildStartBuildBatchJsonPathProps, AWSCDK::StepFunctionsTasks::CodeBuildStartBuildJsonPathProps, AWSCDK::StepFunctionsTasks::DynamoDeleteItemJsonPathProps, AWSCDK::StepFunctionsTasks::DynamoGetItemJsonPathProps, AWSCDK::StepFunctionsTasks::DynamoPutItemJsonPathProps, AWSCDK::StepFunctionsTasks::DynamoUpdateItemJsonPathProps, AWSCDK::StepFunctionsTasks::ECSRunTaskJsonPathProps, AWSCDK::StepFunctionsTasks::EKSCallJsonPathProps, AWSCDK::StepFunctionsTasks::EMRAddStepJsonPathProps, AWSCDK::StepFunctionsTasks::EMRCancelStepJsonPathProps, AWSCDK::StepFunctionsTasks::EMRContainersCreateVirtualClusterJsonPathProps, AWSCDK::StepFunctionsTasks::EMRContainersDeleteVirtualClusterJsonPathProps, AWSCDK::StepFunctionsTasks::EMRContainersStartJobRunJsonPathProps, AWSCDK::StepFunctionsTasks::EMRCreateClusterJsonPathProps, AWSCDK::StepFunctionsTasks::EMRModifyInstanceFleetByNameJsonPathProps, AWSCDK::StepFunctionsTasks::EMRModifyInstanceGroupByNameJsonPathProps, AWSCDK::StepFunctionsTasks::EMRSetClusterTerminationProtectionJsonPathProps, AWSCDK::StepFunctionsTasks::EMRTerminateClusterJsonPathProps, AWSCDK::StepFunctionsTasks::EventBridgePutEventsJsonPathProps, AWSCDK::StepFunctionsTasks::EventBridgeSchedulerCreateScheduleTaskJsonPathProps, AWSCDK::StepFunctionsTasks::GlueDataBrewStartJobRunJsonPathProps, AWSCDK::StepFunctionsTasks::GlueStartCrawlerRunJsonPathProps, AWSCDK::StepFunctionsTasks::GlueStartJobRunJsonPathProps, AWSCDK::StepFunctionsTasks::HttpInvokeJsonPathProps, AWSCDK::StepFunctionsTasks::LambdaInvokeJsonPathProps, AWSCDK::StepFunctionsTasks::MediaConvertCreateJobJsonPathProps, AWSCDK::StepFunctionsTasks::SNSPublishJsonPathProps, AWSCDK::StepFunctionsTasks::SQSSendMessageJsonPathProps, AWSCDK::StepFunctionsTasks::SageMakerCreateEndpointConfigJsonPathProps, AWSCDK::StepFunctionsTasks::SageMakerCreateEndpointJsonPathProps, AWSCDK::StepFunctionsTasks::SageMakerCreateModelJsonPathProps, AWSCDK::StepFunctionsTasks::SageMakerCreateTrainingJobJsonPathProps, AWSCDK::StepFunctionsTasks::SageMakerCreateTransformJobJsonPathProps, AWSCDK::StepFunctionsTasks::SageMakerUpdateEndpointJsonPathProps, AWSCDK::StepFunctionsTasks::StepFunctionsInvokeActivityJsonPathProps, AWSCDK::StepFunctionsTasks::StepFunctionsStartExecutionJsonPathProps

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(comment: nil, query_language: nil, state_name: nil, credentials: nil, heartbeat: nil, heartbeat_timeout: nil, integration_pattern: nil, task_timeout: nil, timeout: nil, assign: nil, input_path: nil, output_path: nil, result_path: nil, result_selector: nil) ⇒ TaskStateJsonPathBaseProps

Returns a new instance of TaskStateJsonPathBaseProps.

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.

  • credentials (AWSCDK::StepFunctions::Credentials, nil) (defaults to: nil) —

    Credentials for an IAM Role that the State Machine assumes for executing the task.

  • heartbeat (AWSCDK::Duration, nil) (defaults to: nil) —

    Timeout for the heartbeat.

  • heartbeat_timeout (AWSCDK::StepFunctions::Timeout, nil) (defaults to: nil) —

    Timeout for the heartbeat.

  • integration_pattern (AWSCDK::StepFunctions::IntegrationPattern, nil) (defaults to: nil) —

    AWS Step Functions integrates with services directly in the Amazon States Language.

  • task_timeout (AWSCDK::StepFunctions::Timeout, nil) (defaults to: nil) —

    Timeout for the task.

  • timeout (AWSCDK::Duration, nil) (defaults to: nil) —

    Timeout for the task.

  • assign (Hash{String => Object}, nil) (defaults to: nil) —

    Workflow variables to store in this step.

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

    JSONPath expression to select part of the state to be the input to this state.

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

    JSONPath expression to select part of the state to be the output to this state.

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

    JSONPath expression to indicate where to inject the state's output.

  • result_selector (Hash{String => Object}, nil) (defaults to: nil) —

    The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.



22
23
24
25
26
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
 
# File 'step_functions/task_state_json_path_base_props.rb', line 22

def initialize(comment: nil, query_language: nil, state_name: nil, credentials: nil, heartbeat: nil, heartbeat_timeout: nil, integration_pattern: nil, task_timeout: nil, timeout: nil, assign: nil, input_path: nil, output_path: nil, result_path: nil, result_selector: 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?
  @credentials = credentials.is_a?(Hash) ? ::AWSCDK::StepFunctions::Credentials.new(**credentials.transform_keys(&:to_sym)) : credentials
  Jsii::Type.check_type(@credentials, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5DcmVkZW50aWFscyJ9")), "credentials") unless @credentials.nil?
  @heartbeat = heartbeat
  Jsii::Type.check_type(@heartbeat, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "heartbeat") unless @heartbeat.nil?
  @heartbeat_timeout = heartbeat_timeout
  Jsii::Type.check_type(@heartbeat_timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UaW1lb3V0In0=")), "heartbeatTimeout") unless @heartbeat_timeout.nil?
  @integration_pattern = integration_pattern
  Jsii::Type.check_type(@integration_pattern, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5JbnRlZ3JhdGlvblBhdHRlcm4ifQ==")), "integrationPattern") unless @integration_pattern.nil?
  @task_timeout = task_timeout
  Jsii::Type.check_type(@task_timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UaW1lb3V0In0=")), "taskTimeout") unless @task_timeout.nil?
  @timeout = timeout
  Jsii::Type.check_type(@timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "timeout") unless @timeout.nil?
  @assign = assign
  Jsii::Type.check_type(@assign, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "assign") unless @assign.nil?
  @input_path = input_path
  Jsii::Type.check_type(@input_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputPath") unless @input_path.nil?
  @output_path = output_path
  Jsii::Type.check_type(@output_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputPath") unless @output_path.nil?
  @result_path = result_path
  Jsii::Type.check_type(@result_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resultPath") unless @result_path.nil?
  @result_selector = result_selector
  Jsii::Type.check_type(@result_selector, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "resultSelector") unless @result_selector.nil?
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:



124
125
126
 
# File 'step_functions/task_state_json_path_base_props.rb', line 124

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


57
58
59
 
# File 'step_functions/task_state_json_path_base_props.rb', line 57

def comment
  @comment
end

#credentials ⇒ AWSCDK::StepFunctions::Credentials? (readonly)

Note:

Default: - None (Task is executed using the State Machine's execution role)

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

Returns:

See Also:



78
79
80
 
# File 'step_functions/task_state_json_path_base_props.rb', line 78

def credentials
  @credentials
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



84
85
86
 
# File 'step_functions/task_state_json_path_base_props.rb', line 84

def heartbeat
  @heartbeat
end

#heartbeat_timeout ⇒ AWSCDK::StepFunctions::Timeout? (readonly)

Note:

Default: - None

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:



92
93
94
 
# File 'step_functions/task_state_json_path_base_props.rb', line 92

def heartbeat_timeout
  @heartbeat_timeout
end

#input_path ⇒ String? (readonly)

Note:

Default: $

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Returns:

  • (String, nil) 


132
133
134
 
# File 'step_functions/task_state_json_path_base_props.rb', line 132

def input_path
  @input_path
end

#integration_pattern ⇒ AWSCDK::StepFunctions::IntegrationPattern? (readonly)

Note:

Default: - IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Returns:

See Also:



102
103
104
 
# File 'step_functions/task_state_json_path_base_props.rb', line 102

def integration_pattern
  @integration_pattern
end

#output_path ⇒ String? (readonly)

Note:

Default: $

JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

  • (String, nil) 


140
141
142
 
# File 'step_functions/task_state_json_path_base_props.rb', line 140

def output_path
  @output_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:



65
66
67
 
# File 'step_functions/task_state_json_path_base_props.rb', line 65

def query_language
  @query_language
end

#result_path ⇒ String? (readonly)

Note:

Default: $

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Returns:

  • (String, nil) 


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

def result_path
  @result_path
end

#result_selector ⇒ Hash{String => Object}? (readonly)

Note:

Default: - None

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Returns:

  • (Hash{String => Object}, nil)

See Also:



157
158
159
 
# File 'step_functions/task_state_json_path_base_props.rb', line 157

def result_selector
  @result_selector
end

#state_name ⇒ String? (readonly)

Note:

Default: - The construct ID will be used as state name

Optional name for this state.

Returns:

  • (String, nil) 


70
71
72
 
# File 'step_functions/task_state_json_path_base_props.rb', line 70

def state_name
  @state_name
end

#task_timeout ⇒ AWSCDK::StepFunctions::Timeout? (readonly)

Note:

Default: - None

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:



110
111
112
 
# File 'step_functions/task_state_json_path_base_props.rb', line 110

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



116
117
118
 
# File 'step_functions/task_state_json_path_base_props.rb', line 116

def timeout
  @timeout
end

Class Method Details

.jsii_properties ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'step_functions/task_state_json_path_base_props.rb', line 159

def self.jsii_properties
  {
    :comment => "comment",
    :query_language => "queryLanguage",
    :state_name => "stateName",
    :credentials => "credentials",
    :heartbeat => "heartbeat",
    :heartbeat_timeout => "heartbeatTimeout",
    :integration_pattern => "integrationPattern",
    :task_timeout => "taskTimeout",
    :timeout => "timeout",
    :assign => "assign",
    :input_path => "inputPath",
    :output_path => "outputPath",
    :result_path => "resultPath",
    :result_selector => "resultSelector",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'step_functions/task_state_json_path_base_props.rb', line 178

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "comment" => @comment,
    "queryLanguage" => @query_language,
    "stateName" => @state_name,
    "credentials" => @credentials,
    "heartbeat" => @heartbeat,
    "heartbeatTimeout" => @heartbeat_timeout,
    "integrationPattern" => @integration_pattern,
    "taskTimeout" => @task_timeout,
    "timeout" => @timeout,
    "assign" => @assign,
    "inputPath" => @input_path,
    "outputPath" => @output_path,
    "resultPath" => @result_path,
    "resultSelector" => @result_selector,
  })
  result.compact
end